SpmiFirstCx Subroutine

Purpose

Locates the first subcontext of a context.

Library

SPMI Library (libSpmi.a)

Syntax

#include sys/Spmidef.h

struct SpmiCxLink *SpmiFirstCx(CxHandle)
SpmiCxHdl CxHandle;

Description

The SpmiFirstCx subroutine locates the first subcontext of a context. The subroutine returns a NULL value if no subcontexts are found.

The structure pointed to by the returned pointer contains a handle to access the contents of the corresponding SpmiCx structure through the SpmiGetCxsubroutine call.

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

Parameters

CxHandle

Specifies a valid SpmiCxHdl handle as obtained by another subroutine call.

Return Values

The SpmiFirstCx subroutine returns a pointer to an SpmiCxLink structure if successful. If unsuccessful, the subroutine returns a NULL 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