Technical Reference: Base Operating System and Extensions, Volume 2

RSiInstantiate Subroutine

Purpose

Creates (instantiates) all subcontexts of an SpmiCx context object.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

int RSiInstantiate(rhandle, context)
RSiHandle rhandle;
cx_handle *context;

Description

The RSiInstantiate subroutine performs the following actions:

Validates that the context identified by the second argument exists.
Instantiates the context so that all subcontexts of that context are created in the context hierarchy. Note that this subroutine call currently only makes sense if the context's SiInstFreq is set to SiContInst or SiCfgInst because all other contexts would have been instantiated whenever the xmservd daemon was started.

The RSiInstantiate subroutine explicitly instantiates the subcontexts of an instantiable context. If the context is not instantiable, do not call the RSiInstantiate subroutine.

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

Parameters

rhandleMust point to a structure of type RSiHandle, which was previously initialized by the RSiOpen (RSiOpen Subroutine) subroutine.

contextMust be a handle of type cx_handle, which was previously returned by a successful RSiPathGetCx (RSiPathGetCx Subroutine) subroutine call.

Return Values

If successful, the subroutine returns a zero value; otherwise it returns an error code as defined in SiError 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 .

Files

/usr/include/sys/Rsi.h

Declares the subroutines, data structures, handles, and macros that an application program can use to access the RSI.

Related Information

For related information, see: