Content-type: text/html Man page of MP_GetTargetPortGroupProperties

MP_GetTargetPortGroupProperties

Section: Common Multipath Management Library Functions (3MPAPI)
Updated: 15 Feb 2006
Index Return to Main Contents
 

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(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface Stability Standard: ANSI INCITS 412 Multipath Management API
MT-LevelSafe

 

SEE ALSO

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

Multipath Management API Version 1.0


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:39:52 GMT, October 02, 2010