IStream_ReadPidl function (shlwapi.h)

Reads a pointer to an item identifier list (PIDL) from an IStream object into a PIDLIST_RELATIVE object.

Syntax

LWSTDAPI IStream_ReadPidl(
  [in]  IStream          *pstm,
  [out] PIDLIST_RELATIVE *ppidlOut
);

Parameters

[in] pstm

Type: IStream*

A pointer to the IStream from which the PIDL is read.

[out] ppidlOut

Type: PIDLIST_RELATIVE*

A pointer to the resulting PIDL.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

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