man pages section 3: Extended Library Functions, Volume 2

IMA_GetPnpStatistics (3IMA)

Name

IMA_GetPnpStatistics - Gets the statistics related to a PNP

Synopsis

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

IMA_STATUS IMA_GetPnpStatistics(
 /* in */     IMA_OID pnpOid,
 /* out */    IMA_PNP_STATISTICS *pStats
);

Parameters

pnpOid

The object ID of the physical network port (PNP) whose statistics are being retrieved.

pStats

A pointer to an IMA_PNP_STATISTICS data structure allocated by the caller. If returned successfully, this data structure contains the current statistics of the specified PNP.

Description

The IMA_GetPnpStatistics() API gets the statistics related to a PNP.

Return Values

IMA_ERROR_INVALID_PARAMETER

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

IMA_ERROR_INVALID_OBJECT_TYPE

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

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the pnpOid argument does not specify a PNP object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the pnpOid argument does not specify a PNP known to the system

IMA_ERROR_STATS_COLLECTION_NOT_ENABLED

Returned if statistics collection is not enabled for the PNP specified by the pnpOid argument

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), IMA_GetStatisticsProperties(3IMA), IMA_SetStatisticsCollection(3IMA)