xref: /illumos-gate/usr/src/man/man3mpapi/MP_GetAssociatedPluginOid.3mpapi (revision dd72704bd9e794056c558153663c739e2012d721)
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_GETASSOCIATEDPLUGINOID 3MPAPI "Feb 15, 2006"
NAME
MP_GetAssociatedPluginOid - get the object ID for the plugin
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lMPAPI [ library.\|.\|. ]
#include <mpapi.h>

MP_STATUS MP_GetAssociatedPluginOid(MP_OID oid,
 MP_OID *pPluginOID);
PARAMETERS
oid

The object ID of an object that has been received from a previous API call.

pPluginOID

A pointer to an object ID that has type MP_OID structure allocated by the caller. With a successful return this will contain the object ID of the plugin associated with the object specified by the oid.

DESCRIPTION

The MP_GetAssociatedPluginOid() function gets the object ID for the plugin associated with the specified object ID. The sequence number subfield of the oid is not validate since this API is implemented in the common library.

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 the API.

MP_STATUS_INVALID_PARAMETER

The pluginOid is null or specifies a memory area to which data cannot be written.

MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID is invalid.

ATTRIBUTES

See attributes(7) 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), attributes (7)

Multipath Management API Version 1.0