MP_GETOBJECTTYPE(3MPAPI)MP_GETOBJECTTYPE(3MPAPI)NAMEMP_GetObjectType - get an object type
SYNOPSIS
cc [ flag... ] file... -lMPAPI [ library... ]
#include <mpapi.h>
MP_STATUS MP_GetObjectType(MP_OID oid, MP_OBJECT_TYPE *pObjectType);
PARAMETERS
oid
The initialized object ID to have the type determined.
pObjectType
A pointer to an object ID that has type MP_OBJECT_TYPE
variable allocated by the caller. With a successful
return it contains the object type of oid.
DESCRIPTION
The MP_GetObjectType() function gets the object type of an initialized
object ID.
This API is provided so that clients can determine the type of object
an object ID represents. This can be very useful for a client function
that receives notifications.
RETURN VALUES
MP_STATUS_INVALID_OBJECT_TYPE
The oid does not specify any valid object type. This is most likely
to happen if an uninitialized object ID is passed to th e API.
MP_STATUS_INVALID_PARAMETER
The pObjectType is null or specifies a memory area to which data
cannot be written.
MP_STATUS_SUCCESS
The operation is successful.
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 ALSOlibMPAPI(3LIB), MP_RegisterForObjectVisibilityChanges(3MPAPI),
attributes(5)
Multipath Management API Version 1.0
Feb 15, 2006 MP_GETOBJECTTYPE(3MPAPI)
