Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_GetNetworkPortalProperties (3IMA)

Name

IMA_GetNetworkPortalProperties - Gets the properties of the specified network portal

Synopsis

cc [ flag... ] file... -lima [ library... ]
#include <ima.h>

IMA_STATUS IMA_GetNetworkPortalProperties(
/* in */     IMA_OID networkPortalOid,
/* out */    IMA_NETWORK_PORTAL_PROPERTIES *pProps
);

Parameters

networkPortalOid

The object ID of the network portal whose properties are retrieved.

pProps

A pointer to an IMA_NETWORK_PORTAL_PROPERTIES data structure allocated by the caller. If returned successfully, this data structure contains the properties of the network portal specified by the networkPortalOid argument.

Description

The IMA_GetNetworkPortalProperties() API gets the properties of the specified network portal.

Return Values

IMA_ERROR_INVALID_PARAMETER

Returned if the pProps argument is NULL, or specifies a memory area to which data cannot be written

IMA_ERROR_INVALID_OBJECT_TYPE

Returned if the networkPortalOid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the networkPortalOid argument does not specify a network portal object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the networkPortalOid argument does not specify an logical network port (LNP) known to the system

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/library/storage/snia-ima
Interface Stability
Volatile
MT-Level
Safe

See Also

libima(3LIB), attributes(7)