RSiDelSetStat 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;

Description

The RSiDelSetStat subroutine performs the following actions:

  1. Validates the SpmiStatSet identified by the second argument exists and contains the SpmiStatVals statistic identified by the third argument.
  2. Deletes the SpmiStatVals value from the SpmiStatSet 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 (RSiOpen Subroutine) subroutine.
ssp
Must be a pointer to a structure type struct SpmiStatSet, which was previously returned by a successful RSiCreateStatSet (RSiCreateStatSet Subroutine) subroutine call.
svp
Must be a handle of type struct SpmiStatVals as returned by a successful RSiPathAddSetStat (RSiPathAddSetStat Subroutine) 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:

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.