PFNDACOMPARECONST callback function (dpa_dsa.h)

Article
2024-02-22

Defines the prototype for the compare function used by DSA_Sort when the items being compared are constant objects.

Syntax

PFNDACOMPARECONST Pfndacompareconst;

int Pfndacompareconst(
  [in, optional] const void *p1,
  [in, optional] const void *p2,
  [in]           LPARAM lParam
)
{...}

Parameters

[in, optional] p1

Type: const void*

A pointer to the first item in the comparison.

[in, optional] p2

Type: const void*

A pointer to the second item in the comparison.

[in] lParam

Type: LPARAM

Additional data passed to pfnCmp.

Return value

Type: int

The meaning of the return values depends on the function that uses this callback prototype. The return values for DSA_Sort are as follows:

less than 0	If p1 should be sorted ahead of p2.
equal to 0	If p1 and p2 should be sorted together.
greater than 0	If p1 should be sorted after p2.

Remarks

Alternate names for this callback are PFNDPACOMPARECONST and PFNDSACOMPARECONST.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	dpa_dsa.h

Share via