MP_GETTARGETPORTPROPERTIES(3MPAPI)
Common Multipath Management Library Functions

NAME

MP_GetTargetPortProperties - get target port properties

SYNOPSIS

cc [ flag... ] file... -lMPAPI [ library... ]
#include <mpapi.h>

MP_STATUS MP_GetTargetPortProperties(MP_OID oid,
MP_TARGET_PORT_GROUP_PROPERTIES *pProps);

PARAMETERS

oid
The object ID of the target port group.


pProps
A pointer to an object ID that has type
MP_TARGET_PORT_GROUP_PROPERTIES structure allocated by the
caller. With a successful return, this structure contains
the properties of the target port group specified by the
oid.

DESCRIPTION

The MP_GetTargetPortProperties() function returns the properties of
the specified target port.

RETURN VALUES

MP_STATUS_INVALID_PARAMETER

The pProps is null or specifies a memory area to which data
cannot be written or when the oid has a type subfield other than
MP_OBJECT_TYPE_TARGET_PORT.


MP_STATUS_INVALID_OBJECT_TYPE

The oid does not specify any valid object type. This is most
likely to happen if an uninitialized object ID is passed to the
API.


MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.


MP_STATUS_SUCCESS

The operation is successful.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+---------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+---------------------------+
|Interface Stability | Standard: ANSI INCITS 412 |
| | Multipath Management API |
+--------------------+---------------------------+
|MT-Level | Safe |
+--------------------+---------------------------+

SEE ALSO

libMPAPI(3LIB), MP_GetTargetPortOidList(3MPAPI), attributes(7)


Multipath Management API Version 1.0

June 13, 2021
MP_GETTARGETPORTPROPERTIES(3MPAPI)