Edit

Share via

NPFMXGetPermHelp function (npapi.h)

  • Article

Retrieves the help file and help context of the permission editor dialog boxes when a menu item in the Security menu of File Manager is selected and F1 is pressed.

Syntax

DWORD NPFMXGetPermHelp(
  [in]      LPWSTR  lpDriveName,
  [in]      DWORD   nDialogType,
  [in]      BOOL    fDirectory,
  [in, out] LPVOID  lpFileNameBuffer,
  [in, out] LPDWORD lpBufferSize,
  [out]     LPDWORD lpnHelpContext
);

Parameters

[in] lpDriveName

Pointer to the name of the drive currently selected in File Manager.

[in] nDialogType

Specifies the menu item in the Security menu of File Manager on which to bring up Help. This can be one of the following values.

Value Meaning
WNPERM_DLG_PERM
 Show help on the Permissions menu item.
WNPERM_DLG_AUDIT
 Show help on the Auditing menu item.
WNPERM_DLG_OWNER
 Show help on the Owner menu item.

[in] fDirectory

Specifies whether the selected item is a directory. This should be set to TRUE if the selected item in File Manager is a directory, and FALSE if it is a file.

[in, out] lpFileNameBuffer

Pointer to a buffer that will receive the help file name.

[in, out] lpBufferSize

Pointer to a DWORD that specifies the size of the buffer passed in. If lpBuffer is not large enough, on return, this contains the size of buffer needed.

[out] lpnHelpContext

Pointer to a DWORD that will receive the help context for the given nType.

Return value

If the function succeeds, the function should return WN_SUCCESS.

If the function fails, it should call SetLastError to set extended error information, which may include the following values.

Return code Description
WN_NOT_SUPPORTED
 The NPFMXGetPermHelp function is not supported in the provider.
WN_BAD_VALUE
 One or more parameters is an unexpected form or value.
WN_MORE_DATA
 The input buffer is too small.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header npapi.h