Skip to content

CDefFolderMenu_Create2 and LPFNDFMCALLBACK articles update #2117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: docs
Choose a base branch
from
Open

CDefFolderMenu_Create2 and LPFNDFMCALLBACK articles update #2117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions sdk-api-src/content/shlobj_core/nc-shlobj_core-lpfndfmcallback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,19 @@ One of the following notifications.
</tr>
<tr>
<td>
<a href="/windows/desktop/shell/registering-control-panel-items">DFM_MERGECONTEXTMENU</a>
<a href="/windows/desktop/shell/dfm-mergecontextmenu">DFM_MERGECONTEXTMENU</a>
</td>
<td>Sent by the default context menu implementation to allow <b>LPFNDFMCALLBACK</b> to add items to the menu.</td>
<td>Sent by the default context menu implementation to allow <b>LPFNDFMCALLBACK</b> to add items to the menu. Notification can be processed using S_OK return value to add the default extension to the menu.</td>
</tr>
<tr>
<td>
<a href="/windows/desktop/shell/preview-handler-guidelines">DFM_INVOKECOMMAND</a>
<a href="/windows/desktop/shell/dfm-invokecommand">DFM_INVOKECOMMAND</a>
</td>
<td>Sent by the default context menu implementation to request <b>LPFNDFMCALLBACK</b> to invoke a menu command.</td>
<td>Sent by the default context menu implementation to request <b>LPFNDFMCALLBACK</b> to invoke a menu command. Notification can be processed using S_FALSE return value to invoke the default command handler.</td>
</tr>
<tr>
<td>
<a href="/windows/desktop/shell/library-ovw">DFM_GETDEFSTATICID</a>
<a href="/windows/desktop/shell/dfm-getdefstaticid">DFM_GETDEFSTATICID</a>
</td>
<td>Sent by the default context menu implementation when the default menu command is being created, allowing an alternate choice to be made.</td>
</tr>
Expand Down Expand Up @@ -134,6 +134,16 @@ Returns S_OK if the message was handled, or an error value otherwise, including
<tr>
<td width="40%">
<dl>
<dt><b>S_FALSE</b></dt>
</dl>
</td>
<td width="60%">
<a href="/windows/desktop/shell/dfm-invokecommand">DFM_INVOKECOMMAND</a> notification: invoke the default command handler.
</td>
</tr>
<tr>
<td width="40%">
<dl>
<dt><b>E_NOTIMPL</b></dt>
</dl>
</td>
Expand Down
42 changes: 37 additions & 5 deletions sdk-api-src/content/shlobj_core/nf-shlobj_core-cdeffoldermenu_create2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ Creates a context menu for a selected group of file folder objects.

Type: <b>PCIDLIST_ABSOLUTE</b>

An <a href="/windows/desktop/api/shtypes/ns-shtypes-itemidlist">ITEMIDLIST</a> structure for the parent folder. This value can be <b>NULL</b>.
An <a href="/windows/desktop/api/shtypes/ns-shtypes-itemidlist">ITEMIDLIST</a> structure for the parent folder. The value is passed to the shell extension <a href="/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ishellextinit-initialize">IShellExtInit::Initialize</a> method. This value can be <b>NULL</b>.

### -param hwnd [in, optional]

Type: <b>HWND</b>

A handle to the parent window. This value can be <b>NULL</b>.
A handle to the parent window. The value is passed to <a href="/windows/desktop/api/shlobj_core/nc-shlobj_core-lpfndfmcallback">LPFNDFMCALLBACK</a> callback and <a href="/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ishellfolder-getuiobjectof">IShellFolder::GetUIObjectOf</a> method. This value can be <b>NULL</b>.

### -param cidl

Expand All @@ -76,20 +76,31 @@ The number of <a href="/windows/desktop/api/shtypes/ns-shtypes-itemidlist">ITEMI

Type: <b>PCUITEMID_CHILD_ARRAY*</b>

A pointer to an array of <a href="/windows/desktop/api/shtypes/ns-shtypes-itemidlist">ITEMIDLIST</a> structures, one for each item that is selected.
A pointer to an array of <a href="/windows/desktop/api/shtypes/ns-shtypes-itemidlist">ITEMIDLIST</a> structures, one for each item that is selected. Absolute <a href="/windows/desktop/api/shtypes/ns-shtypes-itemidlist">ITEMIDLIST</a> are supported, which can be used when <i>psf</i> represents the desktop folder.

### -param psf [in, optional]

Type: <b><a href="/windows/desktop/api/shobjidl_core/nn-shobjidl_core-ishellfolder">IShellFolder</a>*</b>

A pointer to the parent folder's <a href="/windows/desktop/api/shobjidl_core/nn-shobjidl_core-ishellfolder">IShellFolder</a> interface. This <b>IShellFolder</b> must support the <a href="/windows/desktop/api/objidl/nn-objidl-idataobject">IDataObject</a> interface. If it does not, <b>CDefFolderMenu_Create2</b> fails and returns E_NOINTERFACE. This value can be <b>NULL</b>.
A pointer to the parent folder's <a href="/windows/desktop/api/shobjidl_core/nn-shobjidl_core-ishellfolder">IShellFolder</a> interface. This <b>IShellFolder</b> must support the <a href="/windows/desktop/api/objidl/nn-objidl-idataobject">IDataObject</a> interface. If it does not, <b>CDefFolderMenu_Create2</b> fails and returns <a href="/windows/desktop/api/shobjidl_core/nf-shobjidl_core-ishellfolder-getuiobjectof">IShellFolder::GetUIObjectOf</a> result value. This value can be <b>NULL</b>. If this value is <b>NULL</b>, there will be no items in the context menu.

### -param pfn [in, optional]

Type: <b><a href="/windows/desktop/api/shlobj_core/nc-shlobj_core-lpfndfmcallback">LPFNDFMCALLBACK</a></b>

The <a href="/windows/desktop/api/shlobj_core/nc-shlobj_core-lpfndfmcallback">LPFNDFMCALLBACK</a> callback object. This value can be <b>NULL</b> if the callback object is not needed.

Common callback use cases:

<ul>
<li>
Processing <a href="/windows/desktop/shell/dfm-mergecontextmenu">DFM_MERGECONTEXTMENU</a> notification and returning S_OK to add the default extension to the menu.
</li>
<li>
Processing <a href="/windows/desktop/shell/dfm-invokecommand">DFM_INVOKECOMMAND</a> notification and returning S_FALSE to invoke the default command handler.
</li>
</ul>

### -param nKeys

Type: <b>UINT</b>
Expand All @@ -105,7 +116,28 @@ The number of registry keys in the array pointed to by <i>ahkeys</i>.

Type: <b>const HKEY*</b>

A pointer to an array of registry keys that specify the context menu handlers used with the menu's entries. For more information on context menu handlers, see <a href="/windows/desktop/shell/context-menu-handlers">Creating Context Menu Handlers</a>. This array can contain a maximum of 16 registry keys.
A pointer to an array of registry keys that specify the context menu handlers used with the menu's entries. For more information on context menu handlers, see <a href="/windows/desktop/shell/context-menu-handlers">Creating Context Menu Handlers</a> and <a href="/windows/desktop/shell/reg-shell-exts">Registering Shell Extension Handlers</a>. This array can contain a maximum of 16 registry keys.

Common subkeys of <b>HKEY_CLASSES_ROOT</b> that can be used:

<table class="clsStd">
<tr>
<th>Subkey</th>
<th>Description</th>
</tr>
<tr>
<td><b>AllFileSystemObjects</b></td>
<td>All files and file folders</td>
</tr>
<tr>
<td><b>*</b></td>
<td>All files</td>
</tr>
<tr>
<td><b>Directory</b></td>
<td>File folders</td>
</tr>
</table>

### -param ppcm [out]

Expand Down