MP_GETINITIATORPORTOIDLIST(3MPAPI)
Common Multipath Management Library Functions

NAME

MP_GetInitiatorPortOidList - gets a list of the object IDs

SYNOPSIS

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

MP_STATUS MP_GetInitiatorPortOidList(MP_OID oid,
MP_OID_LIST **ppList);

PARAMETERS

oid
The object ID of the plugin.


ppList
A pointer to a pointer to an object ID that has type
MP_OID_LIST structure. With a successful return, this
contains a pointer to an MP_OID_LIST that contains the
object IDs of all the initiator ports associated with the
specified plugin.

DESCRIPTION

The MP_GetInitiatorPortOidList() function gets a list of the object
IDs of all the initiator ports associated with this plugin. When the
caller is finished using the list it must free the memory used by the
list by calling MP_FreeOidList.

RETURN VALUES

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_INVALID_PARAMETER

The ppList 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_PLUGIN.


MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.


MP_STATUS_SUCCESS

The operation is successful.


MP_STATUS_INSUFFICIENT_MEMORY

A memory allocation failure occurred.

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_GetInitiatorPortProperties(3MPAPI), attributes(7)


Multipath Management API Version 1.0

June 13, 2021
MP_GETINITIATORPORTOIDLIST(3MPAPI)