Rate This Document
Findability
Accuracy
Completeness
Readability

GetStatusString

Obtain the status code description:

const char* HMPPS_GetStatusString(HmppResult result);

Parameters

Parameter

Description

Value Range

Input/Output

result

Status code

Enumeration type in HMPPResult

Input

Return Value

  • Success: The description of the status code is returned.
  • Failure: "Not Found This Error Description"

Error Codes

None

Note

Do not release the memory to which the returned pointer points.

Example

void  GetStatusStringExample()
{
    printf("%s\n", HMPPS_GetStatusString(HMPP_STS_NO_ERR));
    printf("%s\n", HMPPS_GetStatusString(HMPP_STS_NULL_PTR_ERR));
    printf("%s\n", HMPPS_GetStatusString(HMPP_STS_SIZE_ERR));
    printf("%s\n", HMPPS_GetStatusString(HMPP_STS_NOT_SUPPORT));
}

Output:

No Error
Null Pointer Error
Vector size <= 0 Error
This system does not support this function