1MP_RegisterForObjeCcotmPmroonpeMrutlytCihpaantghesM(aM3nPMa_PgRAeePmgIei)nstteLriFborraOrbyjeFcutnPcrtoipoenrstyChanges(3MPAPI)
2
3
4
6 MP_RegisterForObjectPropertyChanges - register a client function to be
7 called
8
10 cc [ flag... ] file... -lMPAPI [ library... ]
11 #include <mpapi.h>
12
13 MP_STATUS MP_RegisterForObjectPropertyChanges(
14 MP_OBJECT_PROPERTY_FN pClientFn, MP_OBJECT_TYPE objectType,
15 void *pCallerData, MP_OID pluginOid);
16
17
19 pClientFn A pointer to an object ID that has type MP_OBJECT_PROP‐
20 ERTY_FN function defined by the client. With a success‐
21 ful return, this function is called to inform the client
22 of objects that have had one or more properties changed.
23
24
25 objectType The type of object the client wishes to register for
26 property change callbacks.
27
28
29 pCallerData A pointer that is passed to the callback routine with
30 each event. This might be used by the caller to corre‐
31 late the event to the source of the registration.
32
33
34 pluginOid If this is a valid plugin object ID, then registration
35 is limited to that plugin. If this is zero, then the
36 registration is for all plugins.
37
38
40 The MP_RegisterForObjectPropertyChanges() function registers a client
41 function to be called whenever the property of an object changes.
42
43
44 The function specified by pClientFn is called whenever the property of
45 an object changes. For the purposes of this function, a prop‐
46 erty is defined to be a field in an object's property structure and the
47 object's status. Therefore, the client function is not called if a
48 statistic of the associated object changes. But, it is called when the
49 status changes (e.g., from working to failed) or when a name or other
50 field in a property structure changes.
51
52
53 It is not an error to re-register a client function. However, a client
54 function has only one registration. The first call to deregis‐
55 ter a client function will deregister it no matter how many calls to
56 register the function have been made.
57
58
59 If multiple properties of an object change simultaneously, a client
60 function can be called only once to be notified that all the changes
61 have occurred.
62
64 MP_STATUS_INVALID_OBJECT_TYPE
65
66 The pluginOid or objectType does not specify any valid object type.
67 This is most likely to happen if an uninitialized object ID is
68 passed to the API.
69
70
71 MP_STATUS_OBJECT_NOT_FOUND
72
73 The pluginOid owner ID or object sequence number is invalid.
74
75
76 MP_STATUS_INVALID_PARAMETER
77
78 The pCallerData is null or if the pluginOid has a type subfield
79 other than MP_OBJECT_TYPE_PLUGIN, or when objectType is invalid.
80
81
82 MP_STATUS_SUCCESS
83
84 The operation is successful.
85
86
87 MP_STATUS_FN_REPLACED
88
89 An existing client function is replaced with the one specified in
90 pClientFn.
91
92
94 See attributes(5) for descriptions of the following attributes:
95
96
97
98
99 ┌─────────────────────────────┬─────────────────────────────┐
100 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
101 ├─────────────────────────────┼─────────────────────────────┤
102 │Interface Stability │Standard: ANSI INCITS 412 │
103 │ │Multipath Management API │
104 ├─────────────────────────────┼─────────────────────────────┤
105 │MT-Level │Safe │
106 └─────────────────────────────┴─────────────────────────────┘
107
109 libMPAPI(3LIB), MP_DeregisterForObjectPropertyChanges(3MPAPI),
110 attributes(5)
111
112
113 Multipath Management API Version 1.0
114
115
116
117SunOS 5.11 15MPF_eRbeg2i0s0t6erForObjectPropertyChanges(3MPAPI)