NPFormatNetworkName 函数 （npapi.h）

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

Syntax

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

指示所请求格式类型的 Bitfield。 此参数可以是下列值之一。

此外，可以使用按位 OR 作将以下标志用作上述标志的修饰符。

[in] dwAveCharPerLine

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

返回值

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

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

注解

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

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

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

要求