IDListContainerIsConsistent function (shlobj_core.h)

Verifies that the container structure of an IDList is valid.

Syntax

BOOL IDListContainerIsConsistent(
  [in] PCUIDLIST_RELATIVE pidl,
  [in] UINT               cbAlloc
);

Parameters

[in] pidl

A pointer to the IDList to validate.

[in] cbAlloc

The size, in bytes, of the PIDL specified in the pidl parameter.

Return value

TRUE if the IDList structure is valid; otherwise, FALSE.

Remarks

This function should be used by any code that reads an IDList from a persisted format to ensure that invalid forms do not lead to a security exploit in the code that interprets the IDList. Shell data sources are responsible for validating private sections of the ITEMIDs. Hidden data is validated by the functions that interpret that data.

Requirements

Requirement	Value
Target Platform	Windows
Header	shlobj_core.h (include Shlobj.h)