RSiDelSetHot or RSiDelSetHotx 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;

int RSiDelSetHotx(rhandlex, hsp, hvp)
RSiHandlex rhandlex;struct SpmiHotSet *hsp;struct SpmiHotVals*hvp;

Description

The RSiDelSetHot subroutine performs the following actions:

1. Validates that the SpmiHotSet structure identified by the second argument exists and contains the SpmiHotVals statistic identified by the third argument.
2. Deletes the SpmiHotVals value from the SpmiHotSet 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.

hsp

Must be a pointer to a SpmiHotSet structure of type struct , which was previously returned by a successful RSiCreateHotSet or RSiCreateHotSetx subroutine call.

hvp

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

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