共用方式為

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

Bitfield，指出所要求的格式類型。 此參數可以是下列其中一個值。

值 意義
WNFMT_MULTILINE
 提供者應該將反斜杠 n (\\n) ，其中換行符應該出現在名稱中。 應該表示完整名稱。
WNFMT_ABBREVIATED
 提供者應該縮短網路名稱，讓使用者最有用的資訊會符合可用空間。
 

此外，下列旗標可作為上述旗標的修飾詞，可以使用位 OR 運算來包含。

值 意義
WNFMT_INENUM
 網路名稱會顯示在列舉的內容中，其中 「container」 的名稱緊接在列舉中的網路名稱之前。 這可讓網路提供者從格式化的名稱中移除備援資訊，為使用者提供較不雜亂的顯示。

[in] dwAveCharPerLine

指定在顯示網路名稱的單一行上，將符合的平均字元數。 具體來說，此值定義為控件的寬度，除以 TEXTMETRIC 結構的 tmAveCharWidth 字段，以及用於在控件中顯示的字型。

傳回值

如果函式成功，它應該會傳回WN_SUCCESS。

如果函式失敗，它應該會傳回下列值。 將會忽略所有其他錯誤，而且會使用未格式化的網路名稱。

傳回碼 Description
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