RSiGetRawValue Subroutine

Purpose

Returns a pointer to a valid SpmiStatVals structure for a given SpmiStatVals pointer by extraction from a data_feed packet. This subroutine call should only be issued from a callback function after it has been verified that a data_feed packet was received from the host identified by the first argument.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

struct SpmiStatVals RSiGetRawValue(rhandle, svp, index)
RSiHandle rhandle;
struct SpmiStatVals *svp;
int *index;

Description

The RSiGetRawValue subroutine performs the following:

1. Finds an SpmiStatVals structure in the received data packet based upon the second argument to the subroutine call. This involves a lookup operation in tables maintained internally by the RSi interface.
2. Updates the struct SpmiStat pointer in the SpmiStatVals structure to point at a valid SpmiStat structure.
3. Returns a pointer to the SpmiStatVals structure. The returned pointer points to a static area and is only valid until the next execution of RSiGetRawValue.
4. Updates an integer variable with the index into the ValsSet array of the data_feed packet, which corresponds to the second argument to the call.

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.

svp

A handle of type struct SpmiStatVals, which was previously returned by a successful RSiPathAddSetStat (RSiPathAddSetStat Subroutine) subroutine call.

index

A pointer to an integer variable. When the subroutine call succeeds, the index into the ValsSet array of the data feed packet is returned. The index corresponds to the element that matches the svp argument to the subroutine.

Return Values

If successful, the subroutine returns a pointer; otherwise 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