dpa_dsa.h header

  • 3 minutes to read

This header is used by Windows Controls. For more information, see:

dpa_dsa.h contains the following programming interfaces:

Functions

Title Description
DPA_AppendPtr Inserts a new item at the end of a dynamic pointer array (DPA).
DPA_Clone Duplicates a dynamic pointer array (DPA).
DPA_Create Creates a dynamic pointer array (DPA).
DPA_CreateEx Creates a dynamic pointer array (DPA) using a given specified size and heap location.
DPA_DeleteAllPtrs Removes all items from a dynamic pointer array (DPA) and shrinks the DPA accordingly.
DPA_DeletePtr Removes an item from a dynamic pointer array (DPA). The DPA shrinks if necessary to accommodate the removed item.
DPA_Destroy Frees a Dynamic Pointer Array (DPA).
DPA_DestroyCallback Calls pfnCB on each element of the dynamic pointer array (DPA), then frees the DPA.
DPA_EnumCallback Iterates through the Dynamic Pointer Array (DPA) and calls pfnCB on each item.
DPA_FastDeleteLastPtr Deletes the last pointer from a dynamic pointer array (DPA).
DPA_FastGetPtr Gets the value of the specified pointer in the dynamic pointer array (DPA).
DPA_GetPtr Gets an item from a dynamic pointer array (DPA).
DPA_GetPtrCount Gets the number of pointers in a dynamic pointer array (DPA).
DPA_GetPtrIndex Gets the index of a matching item found in a dynamic pointer array (DPA).
DPA_GetPtrPtr Gets the pointer to the internal pointer array of a dynamic pointer array (DPA).
DPA_GetSize Gets the size of a dynamic pointer array (DPA).
DPA_Grow Changes the number of pointers in a dynamic pointer array (DPA).
DPA_InsertPtr Inserts a new item at a specified position in a dynamic pointer array (DPA). If neccessary, the DPA expands to accommodate the new item.
DPA_LoadStream Loads the dynamic pointer array (DPA) from a stream by calling the specified callback function to read each element.
DPA_Merge Combines the contents of two dynamic pointer arrays (DPAs).
DPA_SaveStream Saves the dynamic pointer array (DPA) to a stream by writing out a header, and then calling the specified callback function to write each element.
DPA_Search Finds an item in a dynamic pointer array (DPA).
DPA_SetPtr Assigns a value to an item in a dynamic pointer array (DPA).
DPA_SetPtrCount Sets the number of pointers in a dynamic pointer array (DPA).
DPA_Sort Sorts the items in a Dynamic Pointer Array (DPA).
DPA_SortedInsertPtr Inserts a new item before or after a specified existing item.
DSA_AppendItem Appends a new item to the end of a dynamic structure array (DSA).
DSA_Clone Duplicates a dynamic structure array (DSA).
DSA_Create Creates a dynamic structure array (DSA).
DSA_DeleteAllItems Deletes all items from a dynamic structure array (DSA).
DSA_DeleteItem Deletes an item from a dynamic structure array (DSA).
DSA_Destroy Frees a dynamic structure array (DSA).
DSA_DestroyCallback Iterates through a dynamic structure array (DSA), calling a specified callback function on each item. Upon reaching the end of the array, the DSA is freed.
DSA_EnumCallback Iterates through the dynamic structure array (DSA) and calls pfnCB on each item.
DSA_GetItem Gets an element from a dynamic structure array (DSA).
DSA_GetItemCount Gets the number of items in a dynamic structure array (DSA).
DSA_GetItemPtr Gets a pointer to an element from a dynamic structure array (DSA).
DSA_GetSize Gets the size of the dynamic structure array (DSA).
DSA_InsertItem Inserts a new item into a dynamic structure array (DSA). If necessary, the DSA expands to accommodate the new item.
DSA_SetItem Sets the contents of an element in a dynamic structure array (DSA).
DSA_Sort Sorts the items in a dynamic structure array (DSA).
DSA_Sort
Str_SetPtrW Sets ppszCurrent to a copy of pszNew and frees the previous value, if necessary.

Callback functions

Title Description
PFNDACOMPARE Defines the prototype for the compare function used by DSA_Sort.
PFNDACOMPARECONST Defines the prototype for the compare function used by DSA_Sort when the items being compared are constant objects.
PFNDAENUMCALLBACK Defines the prototype for the callback function used by dynamic structure array (DSA) and dynamic pointer array (DPA) functions.
PFNDAENUMCALLBACKCONST Defines the prototype for the callback function used by dynamic structure array (DSA) and dynamic pointer array (DPA) functions when the items involved are pointers to constant data.
PFNDPAMERGE Defines the prototype for the merge function used by DPA_Merge.
PFNDPAMERGECONST Defines the prototype for the merge function used by DPA_Merge, using constant values.
PFNDPASTREAM Defines the prototype for the callback function used by DPA_LoadStream and DPA_SaveStream.

Structures

Title Description
DPASTREAMINFO Contains a stream item used by the PFNDPASTREAM callback function.