NAME

EvmStatusTextGet − Formats text version of EVM status code

LIBRARY

EVM Support Library (libevm.so, libevm.a)

SYNOPSIS

#include <evm/evm.h>

EvmStatus_t EvmStatusTextGet(
EvmStatus_t evm_status,
EvmString_t buffer,
EvmSize_t nBytes);

OPERANDS

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

bufferA pointer to a character string where EvmStatusTextGet() should store the formatted event data.  The stored string will be null-terminated, even if truncated, unless the nBytes parameter is zero (0). 

nBytesThe maximum length 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. 

RESTRICTIONS

None

RETURN VALUES

EvmERROR_NONE
The operation was completed without error.

EvmERROR_INVALID_ARGUMENT
One of the arguments to the function was invalid.

ERRORS

None

FILES

None

SEE ALSO

Event Management: EVM(5)