[ Bottom of Page | Previous Page | Next Page | Contents | Index | Library Home | Legal | Search ]

Technical Reference: Base Operating System and Extensions, Volume 2

RSiPathAddSetStat Subroutine

Purpose

Add a single statistics value to an already defined SpmiStatSet.

Library

RSI Library (libSpmi.a)

Syntax

#include sys/Rsi.h

struct SpmiStatVals *RSiPathAddSetStat(rhandle, statset,
path)
RSiHandle rhandle;
struct SpmiStatSet *statset;
char *path;

Parameters

rhandleMust be an RSiHandle, which was previously initialized by the RSiOpen (RSiOpen Subroutine) subroutine.

statsetMust be a pointer to a structure of type struct SpmiStatSet, which was previously returned by a successful RSiCreateStatSet (RSiCreateStatSet Subroutine) subroutine call.

pathMust be the full value path name of the statistics value to add to the SpmiStatSet. The value path name must not include a terminating slash. Note that value path names never start with a slash.

Return Values

If successful, the subroutine returns a pointer to a structure of type struct SpmiStatVals. If an error occurs, NULL is returned and an error text may be placed in the external character array RSiEMsg. If you attempt to add more values to a statset than the current local buffer size allows, RSiErrno is set to RSiTooMany. If you attempt to add more values than the buffer size of the remote host's xmservd daemon allows, RSiErrno is set to RSiBadStat and the status field in the returned packet is set to too_many_values.

The external integer RSiMaxValues holds the maximum number of values acceptable with the data-consumer's buffer size.

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:

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:

[ Top of Page | Previous Page | Next Page | Contents | Index | Library Home | Legal | Search ]