NAME    [Toc]    [Back]

       EvmStatusTextGet - Formats text version of EVM status code

SYNOPSIS    [Toc]    [Back]

       #include <evm/evm.h>

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

OPERANDS    [Toc]    [Back]

       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    [Toc]    [Back]

       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    [Toc]    [Back]

       None

RETURN VALUES    [Toc]    [Back]

       The operation was completed without  error.   One  of  the
       arguments to the function was invalid.

ERRORS    [Toc]    [Back]

       None

LIBRARY    [Toc]    [Back]

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

FILES    [Toc]    [Back]

       None

SEE ALSO    [Toc]    [Back]

       Files: kevm(7)

       Event Management: EVM(5)



                                              EvmStatusTextGet(3)