mp_registerforobjectvisibilitychanges(3mpapi) [opensolaris man page]

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

NAME

       MP_RegisterForObjectVisibilityChanges - register a client function to be called

SYNOPSIS

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

       MP_STATUS MP_RegisterForObjectVisibilityChanges(
	    MP_OBJECT_PROPERTY_FN pClientFn, MP_OBJECT_TYPE objectType,
	    void *pCallerData, MP_OID pluginOid);

PARAMETERS

       pClientFn      A  pointer  to an object ID that has type MP_OBJECT_VISIBILITY_FN function defined by the client. With a	successful return,
		      this function is called to inform the client of objects that have had one or more properties changed.

       objectType     The type of object the client wishes to register for property change callbacks.

       pCallerData    A pointer that is passed to the callback routine with each event. This might be used by the caller to correlate the event to
		      the source of the registration.

       pluginOid      If  this is a valid plugin object ID, then registration is limited to that plugin. If this is zero, then the registration is
		      for all plugins.

DESCRIPTION

       The MP_RegisterForObjectVisibilityChanges() function registers a client function to be called whenever the property of an  object  changes.
       The function specified by pClientFn is called whenever objects appear or disappear.

       It  is  not an error to re-register a client function. However, a client function has only one registration. The first call to deregister a
       client function will deregister it no matter how many calls to register the function have been made.

RETURN VALUES

       MP_STATUS_INVALID_OBJECT_TYPE

	   The pluginOid or objectType 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 pluginOid owner ID or object sequence number is invalid.

       MP_STATUS_INVALID_PARAMETER

	   The pCallerData is null or if the pluginOid has a type subfield other than MP_OBJECT_TYPE_PLUGIN, or when objectType is invalid.

       MP_STATUS_SUCCESS

	   The operation is successful.

       MP_STATUS_FN_REPLACED

	   An existing client function is replaced with the one specified in pClientFn.

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

       Multipath Management API Version 1.0

SunOS 5.11							    15 Feb 2006 		     MP_RegisterForObjectVisibilityChanges(3MPAPI)

Check Out this Related Man Page

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

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

       Multipath Management API Version 1.0

SunOS 5.11							    15 Feb 2006 				MP_GetInitiatorPortOidList(3MPAPI)

Linux and UNIX Man Pages

mp_registerforobjectvisibilitychanges(3mpapi) [opensolaris man page]

Check Out this Related Man Page