1.1.3.4.2 DRV_GENERICCODEC_Close Function

void DRV_GENERICCODEC_Close( DRV_Handle handle )

Summary

Closes an opened-instance of the Generic Codec driver

Description

This routine closes an opened-instance of the Generic Codec driver, invalidating the handle. Any buffers in the driver queue that were submitted by this client will be removed. After calling this routine, the handle passed in "handle" must not be used with any of the remaining driver routines. A new handle must be obtained by calling DRV_GENERICCODEC_Open before the caller may use the driver again.

Preconditions

The DRV_GENERICCODEC_Initialize routine must have been called for the specified Generic Codec driver instance.

DRV_GENERICCODEC_Open must have been called to obtain a valid opened device handle.

Parameters

Returns

None

Remarks

Usually there is no need for the driver client to verify that the Close operation has completed. The driver will abort any ongoing operations when this routine is called.

Example

DRV_HANDLE handle; _// Returned from DRV_GENERICCODEC_Open_

DRV_GENERICCODEC_Close(handle);

C

void DRV_GENERICCODEC_Close(const DRV_HANDLE handle);