share/man/man3mpapi/MP_RegisterForObjectVisibilityChanges.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_REGISTERFOROBJECTVISIBILITYCHANGES 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_RegisterForObjectVisibilityChanges \- register a client function to be
  10 called
  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_RegisterForObjectVisibilityChanges\fR(
  18      \fBMP_OBJECT_PROPERTY_FN\fR \fIpClientFn\fR, \fBMP_OBJECT_TYPE\fR \fIobjectType\fR,
  19      \fBvoid\fR \fI*pCallerData\fR, \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 15n
  29 A pointer to an object ID that has type \fBMP_OBJECT_VISIBILITY_FN\fR function
  30 defined by the client. With a  successful return, this function is called to
  31 inform the client of objects that have had one or more properties changed.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIobjectType\fR\fR
  38 .ad
  39 .RS 15n
  40 The type of object the client wishes to register for property change callbacks.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIpCallerData\fR\fR
  47 .ad
  48 .RS 15n
  49 A pointer that is passed to the callback routine with each event. This might be
  50 used by the caller to correlate the event to the source of the registration.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIpluginOid\fR\fR
  57 .ad
  58 .RS 15n
  59 If this is a valid plugin object ID, then registration is limited to that
  60 plugin. If this is zero, then the registration is for all plugins.
  61 .RE
  62
  63 .SH DESCRIPTION
  64 .sp
  65 .LP
  66 The \fBMP_RegisterForObjectVisibilityChanges()\fR function registers a client
  67 function to be called whenever the property of an object changes. The function
  68 specified by \fIpClientFn\fR is called whenever objects appear or disappear.
  69 .sp
  70 .LP
  71 It is not an error to re-register a client function. However, a client function
  72 has only one registration. The first call to deregister a client function will
  73 deregister it no matter how many calls to register the function have been made.
  74 .SH RETURN VALUES
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 The \fIpluginOid\fR or \fIobjectType\fR does not specify any valid object type.
  83 This is most likely to happen if an uninitialized object ID is passed to the
  84 API.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  91 .ad
  92 .sp .6
  93 .RS 4n
  94 The \fIpluginOid\fR owner ID or object sequence number is invalid.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
 101 .ad
 102 .sp .6
 103 .RS 4n
 104 The \fIpCallerData\fR is null or if the \fIpluginOid\fR has a type subfield
 105 other than \fBMP_OBJECT_TYPE_PLUGIN\fR, or when \fIobjectType\fR is invalid.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBMP_STATUS_SUCCESS\fR\fR
 112 .ad
 113 .sp .6
 114 .RS 4n
 115 The operation is successful.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBMP_STATUS_FN_REPLACED\fR\fR
 122 .ad
 123 .sp .6
 124 .RS 4n
 125 An existing client function is replaced with the one specified in
 126 \fIpClientFn\fR.
 127 .RE
 128
 129 .SH ATTRIBUTES
 130 .sp
 131 .LP
 132 See \fBattributes\fR(5) for descriptions of the following attributes:
 133 .sp
 134
 135 .sp
 136 .TS
 137 box;
 138 c | c
 139 l | l .
 140 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 141 _
 142 Interface Stability     T{
 143 Standard: ANSI INCITS 412 Multipath Management API
 144 T}
 145 _
 146 MT-Level        Safe
 147 .TE
 148
 149 .SH SEE ALSO
 150 .sp
 151 .LP
 152 \fBlibMPAPI\fR(3LIB), \fBMP_DeregisterForObjectVisibilityChanges\fR(3MPAPI),
 153 \fBattributes\fR(5)
 154 .sp
 155 .LP
 156 \fIMultipath Management API Version 1.0\fR