RSiStatGetPath or RSiStatGetPathx Subroutine

Purpose

Finds the full path name of a statistic identified by a SpmiStatVals pointer.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

char *RSiStatGetPath (rhandle, svp)
RSiHandle rhandle;
struct SpmiStatVals *svp;

char *RSiStatGetPathx (rhandlex, svp)
RSiHandlex rhandlex;
struct SpmiStatVals *svp;

Description

The RSiStatGetPath or RSiStatGetPathx subroutine performs the following actions:

1. Validates that the SpmiStatVals statistic identified by the second argument does exist.
2. Returns a pointer to a character array containing the full value path name of the statistic.

The memory area pointed to by the returned pointer is freed when the RSiStatGetPath or RSiStatGetPathx subroutine call is repeated. For each invocation of the subroutine, a new memory area is allocated and its address is returned.

If the calling program needs the returned character string after issuing the RSiStatGetPath or RSiStatGetPathx subroutine call, the program must copy the returned string to locally allocated memory before reissuing the subroutine call.

Parameters

rhandle

Must point to an RSiHandle handle which was previously initialized by the RSiOpen subroutine.

rhandlex

Must point to an RSiHandlex handle which was previously initialized by the RSiOpenx subroutine.

svp

Must be a handle of type struct SpmiStatVals as returned by a successful RSiPathAddSetStat or RSiPathAddSetStatx subroutine call.

Return Values

If successful, the RSiStatGetPath or RSiStatGetPathx subroutine returns a pointer to a character array containing the full path name of the statistic. If unsuccessful, the subroutine returns a NULL 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