Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

MP_GetTargetPortGroupProperties(3MPAPI)

Name

MP_GetTargetPortGroupProperties - return properties of the target port group

Synopsis

cc [ flag… ] file–lMPAPI [ library… ]
#include <mpapi.h>

MP_STATUS MP_GetTargetPortGroupProperties(MP_OID oid,
     MP_TARGET_PORT_GROUP_PROPERTIES *pProps);

Parameters

oid

The object ID of the target port group.

pProps

A pointer to an object ID that has type MP_TARGET_PORT_GROUP_PROPERTIES structure allocated by the caller. With a successful return, this structure contains the properties of the target port group specified by the oid.

Description

The MP_GetTargetPortGroupProperties() function returns the properties of the specified target port group.

Return Values

MP_STATUS_INVALID_PARAMETER

The pProps is null or specifies a memory area to which data cannot be written, or when the oid has a type subfield other than MP_OBJECT_TYPE_TARGET_PORT_GROUP.

MP_STATUS_INVALID_OBJECT_TYPE

The oid does not specify a valid object type. This is most likely to happen if an uninitialized object ID is passed to the API.

MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.

MP_STATUS_SUCCESS

The operation is successful.

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), MP_GetAssociatedTPGOidList(3MPAPI), attributes(7)

Multipath Management API Version 1.0