HP-UX Reference (11i v3 07/02) - 3 Library Functions A-M (vol 6)

EvmStatusTextGet(3) EvmStatusTextGet(3)

NAME

EvmStatusTextGet() - format text version of EVM status code

SYNOPSIS

#include <evm/evm.h>

EvmStatus_t EvmStatusTextGet(

EvmStatus_t

evm_status ,

EvmString_t

buffer,

EvmSize_t

nBytes );

Library

EVM Support Library (libevm.so).

Parameters

evm_status The status code for which a text description is to be prepared.

buffer A pointer to a character string where

EvmStatusTextGet()

stores the formatted event

data. The stored string is null-terminated, even if truncated, unless the nBytes operand is

zero (0).

nBytes The maximum length (number of characters) of the output string. If the formatted status is

longer than nBytes, the output is truncated.

DESCRIPTION

The

EvmStatusTextGet()

routine takes an EVM API status code as input, and returns a string

describing the status. This string can be used for error display or debugging purposes. The string returned

in buffer is null terminated.

RETURN VALUE

EvmERROR_NONE The operation completed without error.

EvmERROR_INVALID_ARGUMENT

One of the arguments to the function is invalid.

ERRORS

The value of

errno is not set.