SHBindToFolderIDListParentEx
TOC
Collapse the table of content
Expand the table of content

SHBindToFolderIDListParentEx function

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

Syntax


HRESULT SHBindToFolderIDListParentEx(
  _In_opt_  IShellFolder       *psfRoot,
  _In_      PCUIDLIST_RELATIVE pidl,
  _In_opt_  IBindCtx           *ppbc,
  _In_      REFIID             riid,
  _Out_     void               **ppv,
  _Out_opt_ PCUITEMID_CHILD    *ppidlLast
);

Parameters

psfRoot [in, optional]

Type: IShellFolder*

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

pidl [in]

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.

ppbc [in, optional]

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.

riid [in]

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.

ppv [out]

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.

ppidlLast [out, optional]

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Shlobj.h

DLL

Shell32.dll

See also

SHBindToFolderIDListParent

 

 

Show:
© 2016 Microsoft