man pages section 3: Extended Library Functions, Volume 2

IMA_GetNetworkPortStatus (3IMA)

Name

IMA_GetNetworkPortStatus - Gets the status of a specified logical or physical network port

Synopsis

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

IMA_STATUS IMA_GetNetworkPortStatus(
 /* in */     IMA_OID portOid,
 /* out */    IMA_NETWORK_PORT_STATUS *pStatus
);

Parameters

portOid

The object ID of the logical or physical network port whose status is being retrieved.

pStatus

A pointer to an IMA_NETWORK_PORT_STATUS variable allocated by the caller. If returned successfully, this variable contains the current status of the specified logical or physical network port.

Description

The IMA_GetNetworkPortStatus() API gets the status of a specified logical or physical network port

Return Values

IMA_ERROR_INVALID_PARAMETER

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

IMA_ERROR_INVALID_OBJECT_TYPE

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

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the portOid argument does not specify a logical or physical network port object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the portOid argument does not specify a logical or physical network port 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)