ddpi_stackstate_get_stack_format operation

The ddpi_stackstate_get_stack_format operation returns the Ddpi_StackState object format.

Prototype

int ddpi_stackstate_get_stack_format(
  Ddpi_StackState       stackstate,
  Ddpi_Stack_Format*    ret_format,
  Ddpi_Error*           error);

Parameters

stackstate
Input. This accepts the Ddpi_StackState object.
ret_format
Output. This returns the stack format.
error
See The libddpi error parameter.

Return values

DW_DLV_OK
Returned when a pointer to the format of the given state-stack object has been successfully retrieved.
DW_DLV_NO_ENTRY
Never returned.
DW_DLV_ERROR
This value is returned if:
  • stackstate is NULL.
  • The Ddpi_Info object associated with stackstate is NULL.
  • ret_format is NULL.