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