SHBindToFolderIDListParentEx function (shlobj_core.h)

Extends the SHBindToFolderIDListParent function by allowing the caller to specify a bind context.

Syntax

SHSTDAPI SHBindToFolderIDListParentEx(
  [in, optional]  IShellFolder       *psfRoot,
  [in]            PCUIDLIST_RELATIVE pidl,
  [in, optional]  IBindCtx           *ppbc,
  [in]            REFIID             riid,
  [out]           void               **ppv,
  [out, optional] PCUITEMID_CHILD    *ppidlLast
);

Parameters

[in, optional] psfRoot

Type: IShellFolder*

A pointer to a Shell folder object. If psfRoot is NULL, indicates that the IDList passed is relative to the desktop.

[in] pidl

Type: PCUIDLIST_RELATIVE

A PIDL to bind to, relative to psfRoot. If psfRoot is NULL, this is an absolute IDList relative to the desktop folder.

[in, optional] ppbc

Type: IBindCtx*

A pointer to IBindCtx interface on a bind context object to be used during this operation. If this parameter is not used, set it to NULL, which is equivalent to calling the SHBindToFolderIDListParent function. Because support for pbc is optional for folder object implementations, some folders may not support the use of bind contexts.

[in] riid

Type: REFIID

Reference to the desired interface ID. This is typically IID_IShellFolder or IID_IShellFolder2, but can be anything supported by the target folder.

[out] ppv

Type: void**

When this function returns, contains the interface pointer requested in riid. This is typically IShellFolder or IShellFolder2, but can be anything supported by the target folder.

[out, optional] ppidlLast

Type: PCUITEMID_CHILD*

A pointer to the last ID of the pidl parameter, and is a child ID relative to the parent folder returned in ppv. This value can be NULL.

Return value

Type: HRESULT

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

Requirements

See also

SHBindToFolderIDListParent