xref: /illumos-gate/usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi (revision b3403853e80914bd0aade9b5b605da4878078173) 
 te
 Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
 Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 MP_DEREGISTERFOROBJECTPROPERTYCHANGES 3MPAPI "June 13, 2021"
 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(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_RegisterForObjectPropertyChanges(3MPAPI),
attributes(5)


Multipath Management API Version 1.0