Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

MP_GetAssociatedPluginOid(3MPAPI)

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
Committed
MT-Level
Safe
Standard
ANSI INCITS 412 Multipath Management API

See Also

libMPAPI(3LIB), attributes(7)

Multipath Management API Version 1.0