DPA_DeleteAllPtrs

This function empties a DPA.

Declaration

BOOL DPA_DeleteAllPtrs (HDPA pdpa);

Parameters

The pdpa argument provides a handle to the DPA.

Return Value

The function returns TRUE for success, else FALSE for failure.

Behaviour

This function frees the heap allocation used for the pointer array, if any, and reinitialises the control structure. The result is effectively a newly created DPA except to retain the allocation unit and choice of heap.

The function fails trivially if the given DPA handle is NULL.

Early Implementations

A variation is known for an early implementation. Version 4.00 merely assumes that the DPA handle is not NULL.

Availability

The DPA_DeleteAllPtrs function is exported from COMCTL32.DLL as ordinal 337 in version 3.50 and higher.

This function was documented among the Settlement Program Interfaces in December 2002, but with Windows 2000 cited as the minimum operating system, despite many years of earlier availability.