opensolaris man page for mp_getmultipathlus

MP_GetMultipathLus(3MPAPI)			   Common Multipath Management Library Functions			MP_GetMultipathLus(3MPAPI)

NAME
       MP_GetMultipathLus - return a list of multipath logical units

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

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

PARAMETERS
       oid	 The object ID of the plugin or device product object.

       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 (multipath) logical units associated with the specified plugin object ID.

DESCRIPTION
       The MP_GetMultipathLus() function returns a list of multipath logical units associated to a 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  that	cannot	be  written,  or  when	oid  has  a  type  subfield   other   than
	   MP_OBJECT_TYPE_DEVICE_PRODUCT or MP_OBJECT_TYPE_PLUG IN.

       MP_STATUS_OBJECT_NOT_FOUND

	   The oid owner ID or object sequence number  is invalid.

       MP_STATUS_SUCCESS

	   The operation is successful.

       MP_STATUS_FAILED

	   The plugin for the specified object ID  is not found.

       MP_STATUS_INSUFFICIENT_MEMORY

	   A memory allocation failure occurred.

ATTRIBUTES
       See attributes(5) 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_GetMPLogicalUnitProperties(3MPAPI), attributes(5)

       Multipath Management API Version 1.0

SunOS 5.11							    15 Feb 2006 					MP_GetMultipathLus(3MPAPI)