NPFormatNetworkName 函数 (npapi.h)

  • 项目

以特定于提供程序的格式设置网络名称的格式，以便在控件中显示。

语法

DWORD NPFormatNetworkName(
  [in]      LPWSTR  lpRemoteName,
  [out]     LPWSTR  lpFormattedName,
  [in, out] LPDWORD lpnLength,
  [in]      DWORD   dwFlags,
  [in]      DWORD   dwAveCharPerLine
);

参数

[in] lpRemoteName

指向要设置格式的网络名称的指针。

[out] lpFormattedName

指向接收格式化名称的字符串的指针。

[in, out] lpnLength

指向 DWORD 的指针，指定 lpFormattedName 缓冲区的大小（以字符为单位）。 如果此函数的返回值WN_MORE_DATA， 则 lpnLength 包含所需的缓冲区大小（以字符为单位）。

[in] dwFlags

指示所请求格式类型的位字段。 此参数的取值可为下列值之一：

值 含义
WNFMT_MULTILINE
 提供程序应将反斜杠 n (\\n) 放在名称中应显示换行符的位置。 应表示全名。
WNFMT_ABBREVIATED
 提供程序应缩短网络名称，以便对用户最有用的信息能够容纳在可用空间中。
 

此外，以下标志（充当上述标志的修饰符）可以使用按位 OR 操作来包含。

值 含义
WNFMT_INENUM
 网络名称显示在枚举的上下文中，其中“容器”的名称紧跟在枚举中的网络名称之前。 这允许网络提供商从格式化的名称中删除冗余信息，从而为用户提供不太混乱的显示。

[in] dwAveCharPerLine

指定在显示网络名称的单行上将容纳的平均字符数。 具体而言，此值定义为控件的宽度除以 TEXTMETRIC 结构的 tmAveCharWidth 字段（从控件中用于显示的字体）。

返回值

如果该函数成功，则它应返回WN_SUCCESS。

如果函数失败，它应返回以下值。 将忽略所有其他错误，并使用未格式化的网络名称。

返回代码 说明
WN_MORE_DATA
 输入缓冲区太小。

注解

此函数允许网络供应商在向用户显示网络名称之前对其进行剪裁或修改。 例如，在通用的“ 打开 ”对话框中， “驱动器 ”组合框显示所有连接的资源及其关联的网络名称。 在显示每个项之前，将调用 NPFormatNetworkName ，并且网络提供程序可以选择编辑名称，使其适合组合框。 更重要的是，网络提供商可以编辑名称，向用户显示网络名称的最重要部分。

请注意， NPFormatNetworkName 不会像大多数其他网络提供程序函数一样路由到每个网络提供程序。 每个网络供应商只需担心设置自己的网络名称的格式。 他们可以假设只有网络提供程序驱动程序生成的名称才会传递到 NPFormatNetworkName。

WNFMT_标志通常在用户界面的不同位置传递，如下表所述。 不应假设将哪些标志传递到何处：此表仅用于帮助每个网络供应商确定修改其网络名称的最佳方法。

显示位置 WNFMT_ MULTILINE WNFMT_ ABBREVIATED WNFMT_ INENUM
“文件管理器 连接 ”对话框，“ 驱动器 ”组合框，选择。 (组合框的选择部分是列表部分上方的上矩形，显示当前选定内容。)   X  
“文件管理器 连接 ”对话框，“ 驱动器 ”组合框，列表。 (组合框的列表部分是显示在组合框选择部分下方的列表框。) X    
文件管理器、 共享目录 列表。   X X
文件管理器 断开连接网络驱动器 列表。 X    
文件管理器，工具栏，组合框，选择。   X  
文件管理器、工具栏、组合框、列表。 X    
常见的 “打开 和 保存 ”对话框、 “驱动器 ”组合框、选择。   X  
常见的 “打开 和 保存 ”对话框、 “驱动器 ”组合框、列表。   X  

要求

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