Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

MP_DeregisterForObjectPropertyChanges(3MPAPI)

Name

MP_DeregisterForObjectPropertyChanges - deregister a previously registered client function

Synopsis

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

MP_STATUS MP_DeregisterForObjectPropertyChanges(
     MP_OBJECT_PROPERTY_FN pClientFn, MP_OBJECT_TYPE objectType,
     MP_OID pluginOid);

Parameters

pClientFn

A pointer to an object ID that has type MP_OBJECT_PROPERTY_FN function defined by the client that was previously registered using the MP_RegisterForObjectPropertyChanges(3MPAPI) API. With a successful return this function will no longer be called to inform the client of object property changes.

objectType

The type of object the client wants to deregister for property change callbacks.

pluginOid

If this is a valid plugin object ID, then registration will be removed from that plugin. If this is zero, then registration is removed for all plugins.

Description

The MP_DeregisterForObjectPropertyChanges() function deregisters a previously registered client function that is to be invoked whenever an object's property changes.

The function specified by pClientFn takes a single parameter of type MP_OBJECT_PROPERTY_FN.

The function specified by pClientFn will no longer be called whenever an object's property changes.

Return Values

MP_STATUS_INVALID_OBJECT_TYPE

The pluginOid parameter 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 pluginOid parameter is not zero and has a type subfield other than MP_OBJECT_TYPE_PLUGIN.

MP_STATUS_OBJECT_NOT_FOUND

The pluginOid owner ID or object sequence number is invalid.

MP_STATUS_UNKNOWN_FN

The pClientFn parameter is not the same as the previously registered function.

MP_STATUS_SUCCESS

The pClientFn parameter is deregistered successfully.

MP_STATUS_FAILED

The pClientFn parameter deregistration is not possible.

Attributes

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

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

See Also

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

Multipath Management API Version 1.0