ILLoadFromStream function (shlobj_core.h)

  • Article

[This function is available through Windows XP Service Pack 2 (SP2) and Windows Server 2003. It might be altered or unavailable in subsequent versions of Windows.]

Deprecated. Loads an ITEMIDLIST structure from a stream.

Syntax

HRESULT ILLoadFromStream(
  [in]  IStream          *pstm,
  [out] PIDLIST_RELATIVE *pidl
);

Parameters

[in] pstm

Type: IStream*

A pointer that indicates the IStream interface that the ITEMIDLIST loads from.

[out] pidl

Type: PIDLIST_RELATIVE*

Address of a pointer to an ITEMIDLIST structure. ILLoadFromStream allocates the necessary memory for the structure, and assigns the address to this parameter.

Return value

Type: HRESULT

Returns S_OK if successful, or a COM error-code otherwise.

Remarks

When you are finished with the ITEMIDLIST structure, you must free it by calling ILFree.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shlobj_core.h (include Shlobj.h)
Library Shell32.lib
DLL Shell32.dll (version 5.0 or later)

See also

ILSaveToStream