共用方式為

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

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

價值觀 Meaning
WNFMT_MULTILINE
 提供者應該將反斜線 n （\\n） 放在名稱中應該出現換行符的位置。 應表達全名。
WNFMT_ABBREVIATED
 提供者應該縮短網路名稱，以便對使用者最有用的資訊適合可用空間。
 

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

價值觀 Meaning
WNFMT_INENUM
 網路名稱會呈現在列舉的內容中，其中「容器」的名稱會緊接在列舉中的網路名稱之前。 這允許網路提供者從格式化名稱中刪除冗餘信息，從而為用戶提供不那麼混亂的顯示。

[in] dwAveCharPerLine

指定將適合顯示網路名稱的單行的平均字元數。 具體而言，此值定義為控制項的寬度除以 TEXTMETRIC 結構的 tmAveCharWidth 欄位，與用於在控制項中顯示的字型。

返回值

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

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

回傳碼 Description
WN_MORE_DATA
 輸入緩衝區太小。

備註

此功能允許網路供應商在向使用者顯示網路名稱之前修剪或修改網路名稱。 例如，在一般的 [ 開啟 ] 對話方塊中，[ 磁碟機] 下拉式方塊會顯示所有連線的資源及其相關聯的網路名稱。 在顯示每個專案之前，會呼叫 NPFormatNetworkName ，而網路提供者可以選擇編輯名稱，使其適合下拉式方塊。 更重要的是，網路提供者可以編輯名稱，以將網路名稱的最重要部分呈現給使用者。

請注意， NPFormatNetworkName 不會像大部分其他網路提供者函式那樣路由傳送至每個網路提供者。 每個網路供應商只需擔心格式化自己的網路名稱。 他們可以假設只有其網路提供者驅動程式所產生的名稱才會傳遞至 NPFormatNetworkName。

WNFMT_旗標通常會在使用者介面的不同位置傳遞，如下表所述。 不應假設哪些旗幟在哪裡傳遞;提供此表格僅用於幫助每個網路供應商決定修改其網路名稱的最佳方法。

顯示位置 WNFMT_多線 WNFMT_縮寫 WNFMT_ INENUM
檔案管理員 連線對話 方塊、 磁碟機 下拉式方塊、選取項目。 （下拉式方塊的選取區段是上方矩形，位於清單區段上方，顯示目前選取範圍。   X  
檔案管理員 連線對話 方塊、 磁碟機 下拉式方塊、清單。 （下拉式方塊的清單區段是顯示在下拉式方塊選取部分下方的清單方塊。 X    
檔案管理員、 共用目錄 清單。   X X
檔案管理員 斷開網路磁碟機 清單。 X    
檔案管理員、工具列、下拉式方塊、選取範圍。   X  
文件管理器、工具欄、組合框、列表。 X    
常見的 開啟 和 儲存對話 方塊、 磁碟機 下拉式方塊、選取範圍。   X  
常見的 [開啟 ] 和 [儲存] 對話方塊、[ 磁碟機 ] 下拉式方塊、清單。   X  

需求

Requirement 價值觀
最低支援的用戶端 Windows XP [僅限傳統型應用程式]
支援的最低伺服器 Windows Server 2003 [僅限傳統型應用程式]
目標平臺 窗戶
Header npapi.h
Library davclnt.lib
  • Last updated on