Status Codes

Declares entities to handle return status codes used in VPI. More...

Enumerations
enum	VPIStatus {   VPI_SUCCESS = 0,   VPI_ERROR_NOT_IMPLEMENTED,   VPI_ERROR_INVALID_ARGUMENT,   VPI_ERROR_INVALID_IMAGE_TYPE,   VPI_ERROR_INVALID_ARRAY_TYPE,   VPI_ERROR_INVALID_PYRAMID_TYPE,   VPI_ERROR_INVALID_PAYLOAD_TYPE,   VPI_ERROR_INVALID_OPERATION,   VPI_ERROR_INVALID_CONTEXT,   VPI_ERROR_DEVICE,   VPI_ERROR_NOT_READY,   VPI_ERROR_BUFFER_LOCKED,   VPI_ERROR_OUT_OF_MEMORY,   VPI_ERROR_INTERNAL }
	Status codes. More...

Functions
const char *	vpiStatusGetName (VPIStatus code)
	Returns a string representation of the status code. More...

Detailed Description

Declares entities to handle return status codes used in VPI.

VPI functions uses codes to return operation statuses.

Enumeration Type Documentation

VPIStatus

enum VPIStatus

#include <vpi/Types.h>

Status codes.

When an status is generated, a descriptive error message is printed in stderr.

Enumerator
VPI_SUCCESS	Operation completed successfully.
VPI_ERROR_NOT_IMPLEMENTED	Operation isn't implemented.
VPI_ERROR_INVALID_ARGUMENT	Invalid argument, either wrong range or value not accepted.
VPI_ERROR_INVALID_IMAGE_TYPE	Image type not accepted.
VPI_ERROR_INVALID_ARRAY_TYPE	Array type not accepted.
VPI_ERROR_INVALID_PYRAMID_TYPE	Pyramid type not accepted.
VPI_ERROR_INVALID_PAYLOAD_TYPE	Payload not created for this algorithm.
VPI_ERROR_INVALID_OPERATION	Operation isn't valid in this context.
VPI_ERROR_INVALID_CONTEXT	Context is invalid or is already destroyed.
VPI_ERROR_DEVICE	Device backend error.
VPI_ERROR_NOT_READY	Operation not completed yet, try again later.
VPI_ERROR_BUFFER_LOCKED	Invalid operation on a locked buffer.
VPI_ERROR_OUT_OF_MEMORY	Not enough free memory to allocate object.
VPI_ERROR_INTERNAL	Internal, non specific error.

Definition at line 522 of file Types.h.

Function Documentation

vpiStatusGetName()

const char* vpiStatusGetName

(

VPIStatus

code

)

#include <vpi/Status.h>

Returns a string representation of the status code.

Parameters

[in]

code

Status code whose string representation is to be returned.

Returns

The string representation of the code. The returned pointer points to a static string, hence it must not be freed.