SpmiGetStat Subroutine

Purpose

Returns a pointer to the SpmiStat structure corresponding to a specified statistic handle.

Library

SPMI Library (libSpmi.a)

Syntax

#include sys/Spmidef.h

struct SpmiStat *SpmiGetStat(StatHandle)
SpmiStatHdl StatHandle;

Description

The SpmiGetStat subroutine returns a pointer to the SpmiStat structure corresponding to the statistic handle identified by the StatHandle parameter.

This subroutine is part of the server option of the Performance Aide for AIX licensed product.

Parameters

StatHandle

Specifies a valid SpmiStatHdl handle as obtained by another subroutine call.

Return Values

The SpmiGetStat subroutine returns a pointer to a structure of type SpmiStat if successful. If unsuccessful, the subroutine returns a NULL value.

Error Codes

All SPMI subroutines use external variables to provide error information. To access these variables, an application program must define the following external variables:

• extern char SpmiErrmsg[];
• extern int SpmiErrno;

If the subroutine returns without an error, the SpmiErrno variable is set to 0 and the SpmiErrmsg character array is empty. If an error is detected, the SpmiErrno variable returns an error code, as defined in the sys/Spmidef.h file, and the SpmiErrmsg variable contains text, in English, explaining the cause of the error.

Files