RSiDelSetStat or RSiDelSetStatx Subroutine

Purpose

Deletes a single statistic identified by an SpmiStatVals pointer from an SpmiStatSet.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

int RSiDelSetStat(rhandle, ssp, svp)
RSiHandle rhandle;struct SpmiStatSet *ssp;struct SpmiStatVals*svp;

int RSiDelSetStatx(rhandlex, ssp, svp)
RSiHandlex rhandlex;struct SpmiStatSet *ssp;struct SpmiStatVals*svp;

Description

The RSiDelSetStat, RSiDelSetStatx subroutines performs the following actions:

1. Validates the SpmiStatSet structure identified by the second argument exists and contains the SpmiStatVals statistic identified by the third argument.
2. Deletes the SpmiStatVals value from the SpmiStatSet structure so that future data_feed packets do not include the deleted 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 subroutine.

rhandlex

Must be an RSiHandlex handle, which was previously initialized by the RSiOpenx subroutine.

ssp

Must be a pointer to a SpmiStatSet structure of type struct , which was previously returned by a successful RSiCreateStatSet, RSiCreateStatSetx subroutine call.

svp

Must be a handle of the SpmiStatVals structure of type struct as returned by a successful RSiPathAddSetStat, RSiPathAddSetStatx subroutine call.

Return Values

If successful, the subroutine returns a zero value; otherwise it returns a non-zero value 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