NPGetPropertyText 函数 (npapi.h)

  • 项目

检索要添加到网络资源的属性对话框中的按钮的名称。

语法

DWORD NPGetPropertyText(
  [in]      DWORD  iButton,
  [in]      DWORD  nPropSel,
  [in]      LPWSTR lpName,
  [out]     LPWSTR lpButtonName,
  [in, out] DWORD  nButtonNameLen,
  [in]      DWORD  nType
);

参数

[in] iButton

指示按钮的索引。 文件管理器最多支持六个按钮。 如果只选择了一个文件，则每个可能的按钮的此参数编号为 1-6;如果选择了多个文件，则为 11-16。

[in] nPropSel

指定属性对话框所关注的项。 这可以是以下值之一。

值 含义
WNPS_FILE
 单个文件。
WNPS_DIR
 单个目录。
WNPS_MULT
 选择多个文件和/或目录。

[in] lpName

指向以 null 结尾的字符串的指针，该字符串包含要通过对话框查看或编辑的一个或多个项的名称。 唯一支持的项是文件和目录，因此项名称是文件名。 这些应明确，不包含通配符，并且 (完全限定，例如，C:\LOCAL\EXAMPLE.DOC) 。 多个文件名应用空格分隔。 包含空格的文件名可能用引号括起来， (例如，“C：\My File”) 。 在本例中。 它被视为单个名称。 脱字号“^”也可用作单个字符的引用机制， (例如 C：\My^“File、”C：\My^“File”、“C：\My^”File“都引用文件 C：\My”File) 。

[out] lpButtonName

指向网络提供程序应复制属性按钮名称的缓冲区的指针。 成功后， lpButtonName 指向的缓冲区包含属性按钮的名称。 如果退出时此缓冲区包含空字符串，则将从对话框中删除对应于该名称和所有后续按钮的按钮。 网络提供商无法“跳过”按钮。

[in, out] nButtonNameLen

指定 lpButtonName 缓冲区的大小（以字符为单位），包括终止 null 字符。

[in] nType

指定必须WNTYPE_FILE的项类型。

返回值

如果该函数成功，则它应返回WN_SUCCESS，并且可以使用 lpButtonName 。 如果它指向空字符串，则没有按钮对应于高达 iButton 的索引。 如果返回值不是 WN_SUCCESS，则提供程序还应调用 SetLastError 来设置扩展错误信息。 扩展错误代码包括以下内容。

返回代码 说明
WN_OUT_OF_MEMORY
 无法从资源加载字符串。
WN_MORE_DATA
 给定的缓冲区太小，无法容纳按钮的文本。
WN_BAD_VALUE
 lpName 参数是一种意外形式。
WN_NOT_SUPPORTED
 给定对象类型 nType 不支持属性对话框。

注解

每次启动属性对话框时，文件管理器都会调用此函数，并在显示对话框之前执行此操作。 如果用户单击网络提供程序通过此函数添加的按钮，则会使用适当的参数调用 NPPropertyDialog 函数。

只有文件管理器调用 NPGetPropertyText，并且它对文件和目录使用此函数。

要求

要求 值
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 npapi.h