IContextMenu2::GetCommandString
[Now
Supported on Windows NT]
Retrieves the
language-independent command string or the help text for a context menu item.
HRESULT GetCommandString(
|
UINT idCmd, |
//Menu item
identifier offset |
|
UINT uFlags, |
//Specifies
information to retrieve |
|
UINT *pwReserved, |
//Reserved;
must be NULL |
|
LPSTR pszName, |
//Address
of buffer to receive string |
|
UINT cchMax |
//Size of
the buffer that receives the string |
|
); |
|
Parameters
idCmd
Menu item
identifier offset.
uFlags
Flag
specifying the information to retrieve. This parameter can be one of the
following values:
|
Value |
Meaning |
|
GCS_HELPTEXT |
Returns the
help text for the menu item. |
|
GCS_VALIDATE |
Validates
that the menu item exists. |
|
GCS_VERB |
Returns the
language-independent command name for the menu item. |
pwReserved
Reserved.
Applications must specify NULL when calling this method, and handles must
ignore this parameter when called.
pszName
Address of
the buffer that receives the null-terminated string being retrieved.
cchMax
Size of the
buffer that receives the null-terminated string.
Return Values
Returns
NOERROR if successful or an OLE-defined error code otherwise.
Remarks
The
language-independent command name is a name that can be passed to the IContextMenu::InvokeCommand method to activates a
command by an application. The help text is a description that the Explorer
displays in its status bar; it should be reasonably short (under 40
characters).
See Also