DiveEndImageBufferAccess

This function must be called after reading or writing data in a buffer allocated with DiveAllocImageBuffer and corresponding to the DiveBeginImageBufferAccess.

Syntax

_DiveEndImageBufferAccess(hDiveInst, ulBufferNumber)

Parameters

hDiveInst (HDIVE) - input

Display engine DIVE instance.

ulBufferNumber (ULONG) - input

DIVE instance buffer number for which access is complete.

Returns

rc (ULONG) - returns

Return codes indicating success or type of failure:

• DIVE_SUCCESS If the function succeeds, 0 is returned.
• DIVE_ERR_INVALID_BUFFER_NUMBER The ulBufferNumber parameter must be a previously allocated or associated buffer number before it can be accessed.
• DIVE_ERR_INVALID_INSTANCE The DIVE instance handle specified in the hDiveInst parameter is invalid.

Remarks

This function has no effect if the image buffer was allocated in system memory.

Example Code

#include <dive.h>

HDIVE hDiveInst;      /* Display engine DIVE instance. */
ULONG ulBufferNumber; /* Buffer number for which access is complete. */
ULONG rc;             /* Return codes. */

rc = DiveEndImageBufferAccess(hDiveInst, ulBufferNumber);