Technical Reference: Base Operating System and Extensions , Volume 2

RSiDelSetHot Subroutine

Purpose

Deletes a single set of peer statistics identified by an SpmiHotVals structure from an SpmiHotSet.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

int RSiDelSetHot(rhandle, hsp, hvp)
RSiHandle rhandle;struct SpmiHotSet *hsp;struct SpmiHotVals*hvp;

Description

The RSiDelSetHot subroutine performs the following actions:

1. Validates that the SpmiHotSet identified by the second argument exists and contains the SpmiHotVals statistic identified by the third argument.
2. Deletes the SpmiHotVals value from the SpmiHotSet so that future data_feed packets do not include the deleted statistic.

Parameters

rhandleMust be an RSiHandle, which was previously initialized by the RSiOpen (RSiOpen Subroutine) subroutine.

hspMust be a pointer to a structure type struct SpmiHotSet, which was previously returned by a successful RSiCreateHotSet subroutine call.

hvpMust be a handle of type struct SpmiHotVals as returned by a successful RSiAddSetHot (RSiAddSetHot Subroutine) subroutine call. You cannot specify an SpmiHotVals that was internally generated by the Spmi library code as described under the GrandParent parameter to RSiAddSetHot (RSiAddSetHot Subroutine).

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 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. RSi error codes are described in List of RSi Error Codes.

Implementation Specifics

This subroutine is part of the Performance Toolbox for AIX licensed product.

Files

Related Information

For related information, see:

• RSiOpen Subroutine
• RSiAddSetHot Subroutine.