EvmStatusTextGet(3)EvmStatusTextGet(3)NAMEEvmStatusTextGet - Formats text version of EVM status code
SYNOPSIS
#include <evm/evm.h>
EvmStatus_t EvmStatusTextGet(
EvmStatus_t evm_status,
EvmString_t buffer,
EvmSize_t nBytes );
OPERANDS
The status code for which a text description is to be prepared. A
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 operand is zero (0). The 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
The operation was completed without error. One of the arguments to the
function was invalid.
ERRORS
None
LIBRARY
EVM Support Library (libevm.so, libevm.a)
FILES
None
SEE ALSO
Files: kevm(7)
Event Management: EVM(5)EvmStatusTextGet(3)