SpmiFreeHotSet Subroutine

Purpose

Erases a hotset.

Library

SPMI Library (libSpmi.a)

Syntax

#include sys/Spmidef.h

int SpmiFreeHotSet(HotSet)
struct SpmiHotSet *HotSet;

Description

The SpmiFreeHotSet subroutine erases the hotset identified by the HotSet parameter. All SpmiHotVals structures chained off the SpmiHotSet structure are deleted before the set itself is deleted.

This subroutine is part of the server option of the Performance Aide for AIX® licensed product.

Parameters

HotSet

Specifies a pointer to a valid structure of type SpmiHotSet as created by the SpmiCreateHotSet subroutine call.

Return Values

The SpmiFreeHotSet subroutine returns a value of 0 if successful. If unsuccessful, the subroutine returns a nonzero value.

Error Codes

All SPMI subroutines use external variables to provide error information. To access these variables, an application program must define the following external variables:

• extern char SpmiErrmsg[];
• extern int SpmiErrno;

If the subroutine returns without an error, the SpmiErrno variable is set to 0 and the SpmiErrmsg character array is empty. If an error is detected, the SpmiErrno variable returns an error code, as defined in the sys/Spmidef.h file, and the SpmiErrmsg variable contains text, in English, explaining the cause of the error.

Files