usr/src/man/man3mpapi/MP_DeregisterForObjectPropertyChanges.3mpapi

   1 '\" te
   2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH MP_DEREGISTERFOROBJECTPROPERTYCHANGES 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_DeregisterForObjectPropertyChanges \- deregister a previously registered
  10 client function
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  15 #include <mpapi.h>
  16
  17 \fBMP_STATUS\fR \fBMP_DeregisterForObjectPropertyChanges\fR(
  18      \fBMP_OBJECT_PROPERTY_FN\fR \fIpClientFn\fR, \fBMP_OBJECT_TYPE\fR \fIobjectType\fR,
  19      \fBMP_OID\fR \fIpluginOid\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIpClientFn\fR\fR
  27 .ad
  28 .RS 14n
  29 A pointer to an object ID that has type \fBMP_OBJECT_PROPERTY_FN\fR function
  30 defined by the client that was previously registered using the
  31 \fBMP_RegisterForObjectPropertyChanges\fR(3MPAPI) API. With a successful return
  32 this function will no longer be called to inform the client of object property
  33 changes.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIobjectType\fR\fR
  40 .ad
  41 .RS 14n
  42 The type of object the client wants to deregister for property change
  43 callbacks.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIpluginOid\fR\fR
  50 .ad
  51 .RS 14n
  52 If this is a valid plugin object ID, then registration will be removed from
  53 that plugin. If this is zero, then registration is removed for all plugins.
  54 .RE
  55
  56 .SH DESCRIPTION
  57 .sp
  58 .LP
  59 The \fBMP_DeregisterForObjectPropertyChanges()\fR function deregisters a
  60 previously registered client function that is to be invoked whenever an
  61 object's property changes.
  62 .sp
  63 .LP
  64 The function specified by \fIpClientFn\fR takes a single parameter of type
  65 \fBMP_OBJECT_PROPERTY_FN\fR.
  66 .sp
  67 .LP
  68 The function specified by \fIpClientFn\fR will no longer be called whenever an
  69 object's property changes.
  70 .SH RETURN VALUES
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 The \fIpluginOid\fR parameter does not specify any valid object type. This is
  79 most likely to happen if an uninitialized object ID is passed to the API.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 The \fIpluginOid\fR parmeter is not zero and has a type subfield other than
  90 \fBMP_OBJECT_TYPE_PLUGIN\fR.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  97 .ad
  98 .sp .6
  99 .RS 4n
 100 The \fIpluginOid\fR owner ID or object sequence number is invalid.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBMP_STATUS_UNKNOWN_FN\fR\fR
 107 .ad
 108 .sp .6
 109 .RS 4n
 110 The \fIpClientFn\fR parmeter is not the same as the previously registered
 111 function.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBMP_STATUS_SUCCESS\fR\fR
 118 .ad
 119 .sp .6
 120 .RS 4n
 121 The \fIpClientFn\fR parmeter is deregistered successfully.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBMP_STATUS_FAILED\fR\fR
 128 .ad
 129 .sp .6
 130 .RS 4n
 131 The \fIpClientFn\fR parmeter deregistration is not possible.
 132 .RE
 133
 134 .SH ATTRIBUTES
 135 .sp
 136 .LP
 137 See \fBattributes\fR(5) for descriptions of the following attributes:
 138 .sp
 139
 140 .sp
 141 .TS
 142 box;
 143 c | c
 144 l | l .
 145 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 146 _
 147 Interface Stability     T{
 148 Standard: ANSI INCITS 412 Multipath Management API
 149 T}
 150 _
 151 MT-Level        Safe
 152 .TE
 153
 154 .SH SEE ALSO
 155 .sp
 156 .LP
 157 \fBlibMPAPI\fR(3LIB), \fBMP_RegisterForObjectPropertyChanges\fR(3MPAPI),
 158 \fBattributes\fR(5)
 159 .sp
 160 .LP
 161 \fIMultipath Management API Version 1.0\fR