xref: /illumos-gate/usr/src/man/man3mpapi/MP_GetObjectType.3mpapi (revision b7daf79982d77b491ef9662483cd4549e0e5da9a)
te
Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
MP_GETOBJECTTYPE 3MPAPI "Feb 15, 2006"
NAME
MP_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 ALSO

libMPAPI(3LIB), MP_RegisterForObjectVisibilityChanges(3MPAPI), attributes(5)

Multipath Management API Version 1.0