man pages section 3: Extended Library Functions, Volume 2

IMA_GetStatisticsProperties (3IMA)

Name

IMA_GetStatisticsProperties - Gets the statistics properties of the specified target, LU, or PNP

Synopsis

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

IMA_STATUS IMA_GetStatisticsProperties(
 /* in */     IMA_OID oid,
 /* out */    IMA_STATISTICS_PROPERTIES *pProps
);

Parameters

oid

The object ID of the target, logical unit (LU) ,or physical network port (PNP) whose statistics are retrieved.

pProps

A pointer to an IMA_STATISTICS_PROPERTIES data structure. If returned successfully, this data structure contains the statistics properties of the specified object.

Description

The IMA_GetStatisticsProperties() API gets the statistics properties of the specified target, LU, or PNP.

Return Values

IMA_ERROR_NOT_SUPPORTED

Returned if setting statistics collection is not supported for the specified object

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 oid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the oid argument does not specify a target, LU, or PNP object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify a target, LU, or PNP object 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), IMA_GetDeviceStatistics(3IMA), IMA_GetTargetErrorStatistics(3IMA), IMA_SetStatisticsCollection(3IMA)