Payload

Declaration of payload handling functions and types;. More...

Typedefs
typedef struct VPIPayloadImpl *	VPIPayload
	A handle to an algorithm payload.

Functions
VPIStatus	vpiPayloadGetFlags (VPIPayload payload, uint64_t *flags)
	Returns the flags associated with a payload. More...
void	vpiPayloadDestroy (VPIPayload payload)
	Deallocates the payload object and all associated resources. More...

Detailed Description

Declaration of payload handling functions and types;.

Function Documentation

vpiPayloadGetFlags()

VPIStatus vpiPayloadGetFlags	(	VPIPayload	payload,
		uint64_t *	flags
	)

#include <vpi/Stream.h>

Returns the flags associated with a payload.

Parameters

[in]	payload	Payload to be queried.
[out]	flags	The flags associated with a payload.

Return values

VPI_ERROR_INVALID_ARGUMENT	Output flags pointer is NULL.
VPI_SUCCESS	Operation executed successfully.

vpiPayloadDestroy()

void vpiPayloadDestroy

(

VPIPayload

payload

)

#include <vpi/Stream.h>

Deallocates the payload object and all associated resources.

Parameters

[in]

payload

Payload handle. Passing NULL is allowed, to which the function simply does nothing.