Purpose
Returns the
next statistic of an SpmiCx context.
Library
RSI Library
(libSpmi.a)
Syntax
#include sys/Rsi.h
struct SpmiStatLink *RSiNextStat(rhandle, context, link, name,
descr)
RSiHandle rhandle;
cx_handle *context;
struct SpmiStatLink *link;
char **name;
char **descr;
Description
The RSiNextStat subroutine:
- Validates that a context identified by the second argument exists.
- Returns a handle to the next element of the list of statistics
defined for the context.
- Returns the short name and description of the statistic.
This subroutine is part of the Performance Toolbox for AIX® licensed product.
Parameters
- rhandle
- Must point to a valid RSiHandle handle, which was previously
initialized by the RSiOpen (RSiOpen Subroutine) subroutine.
- context
- Must be a handle of type cx_handle, which was previously
returned by a successful RSiPathGetCx (RSiPathGetCx Subroutine) subroutine call.
- link
- Must be a pointer to a structure of type struct SpmiStatLink, which was previously returned
by a successful RSiFirstStat (RSiFirstStat Subroutine) or RSiNextStat subroutine
call.
- name
- Must be a pointer to a pointer to a character array. The pointer
must be initialized to point at a character array pointer. When the
subroutine call is successful, the short name of the statistics value
is returned in the character array pointer.
- descr
- Must be a pointer to a pointer to a character array. The pointer
must be initialized to point at a character array pointer. When the
subroutine call is successful, the description of the statistics value
is returned in the character array pointer.
Return Values
If successful,
the subroutine returns a pointer to a structure of type struct
SpmiStatLink. If an error occurs, or if no more statistics exists
for the context, NULL is returned and an error text may be placed
in the external character array RSiEMsg.
Error Codes
All Remote
Statistic Interface (RSI) subroutines use external variables to provide
error information. To access these variables, an application program
must define the following external variables:
- extern char RSiEMsg[];
- extern int RSiErrno;
If the subroutine returns without an error, the RSiErrno variable
is set to RSiOkay and the RSiEMsg character array is
empty. If an error is detected, the RSiErrno variable returns
an error code, as defined in the enum RSiErrorType.
Files
Item |
Description |
/usr/include/sys/Rsi.h |
Declares the subroutines, data structures, handles, and macros
that an application program can use to access the RSI. |