Index for Section 3

Alphabetical listing for E

Bottom of page

EvmStatusTextGet(3)
NAME
  EvmStatusTextGet - 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
  evm_status
      The status code for which a text description is to be prepared.

  buffer
      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).

  nBytes
      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
  EvmERROR_NONE
      The operation was completed without error.

  EvmERROR_INVALID_ARGUMENT
      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)

Index for Section 3

Alphabetical listing for E

Top of page