DiveFreeImageBuffer

This function deallocates an image buffer allocated by DiveAllocImageBuffer.

Syntax

_DiveFreeImageBuffer(hDiveInst, ulBufferNumber)

Parameters

hDiveInst (HDIVE) - input

Display engine DIVE instance.

ulBufferNumber (ULONG) - input

Buffer number to free in this instance.

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.
• DIVE_ERR_INVALID_INSTANCE The DIVE instance handle specified in the hDiveInst parameter is invalid.

Remarks

This section has no remarks.

Example Code

#include <dive.h>

HDIVE hDiveInst;      /* Display engine DIVE instance. */
ULONG ulBufferNumber; /* Buffer number to free. */
ULONG rc;             /* Return codes. */

rc = DiveFreeImageBuffer(hDiveInst, ulBufferNumber);