WNetGetResourceInformationA 函式 (winnetwk.h)
當提供網路資源的遠端路徑時, WNetGetResourceInformation 函式 會識別擁有資源的網路提供者,並取得資源類型的相關信息。 函式通常會與 WNetGetResourceParent 函式搭配使用,以剖析和解譯使用者輸入的網路路徑。
語法
DWORD WNetGetResourceInformationA(
[in] LPNETRESOURCEA lpNetResource,
[out] LPVOID lpBuffer,
[in, out] LPDWORD lpcbBuffer,
[out] LPSTR *lplpSystem
);
參數
[in] lpNetResource
NETRESOURCE 結構的指標,指定需要資訊的網路資源。
結構的 lpRemoteName 成員應該指定資源的遠端路徑名稱,通常是使用者輸入的一個。 如果已知,也應該填入 lpProvider 和 dwType 成員,因為此作業可能會耗用大量記憶體,特別是當您未指定 dwType 成員時。 如果您不知道這些成員的值,您應該將它們設定為 NULL。 會忽略 NETRESOURCE 結構的所有其他成員。
[out] lpBuffer
要接收結果之緩衝區的指標。 成功傳回時,緩衝區的第一個部分是 NETRESOURCE 結構,代表透過 WNet 函式存取的輸入資源路徑部分,而不是透過輸入資源類型特定的系統函式。 (緩衝區的其餘部分包含 NETRESOURCE 結構 point.) 成員的可變長度字串
例如,如果輸入遠端資源路徑是 \server\share\dir1\dir2,則輸出 NETRESOURCE 結構會包含資源 \server\share 的相關信息。 路徑的 \dir1\dir2 部分是透過 檔案管理功能來存取。 會傳回 NETRESOURCE 的 lpRemoteName、lpProvider、dwType、dwDisplayType 和 dwUsage 成員,並將所有其他成員設定為 NULL。
lpRemoteName 成員的語法與 WNetEnumResource 函式從列舉傳回的語法相同。 這可讓呼叫端執行字串比較,以判斷傳遞至 WNetGetResourceInformation 的資源是否與個別呼叫 WNetEnumResource 所傳回的資源相同。
[in, out] lpcbBuffer
專案上位置的指標,以位元組為單位指定 lpBuffer 緩衝區的大小。 您配置的緩衝區必須夠大,才能保存 NETRESOURCE 結構,再加上其成員指向的字串。 如果緩衝區對結果而言太小,這個位置會收到所需的緩衝區大小,而且函式會傳回ERROR_MORE_DATA。
[out] lplpSystem
如果函式成功傳回,此參數會指向輸出緩衝區中的字串,指定透過系統函式存取的資源部分。 (這隻適用於資源類型特定的函式,而不是 WNet functions.)
例如,如果輸入遠端資源名稱是 \server\share\dir1\dir2,輸出 NETRESOURCE 結構的 lpRemoteName 成員會指向 \server\share。 此外, lplpSystem 參數會指向 \dir1\dir2。 這兩個字串都會儲存在 lpBuffer 參數指向的緩衝區中。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值是 系統錯誤碼,例如下列其中一個值。
傳回碼 | Description |
---|---|
|
輸入 lpRemoteName 成員不是任何網路的現有網路資源。 |
|
輸入 dwType 成員不符合 lpRemoteName 成員所指定的資源類型。 |
|
發生網路特定錯誤。 呼叫 WNetGetLastError 以取得錯誤的描述。 |
|
由 lpBuffer 參數指向的緩衝區太小。 |
|
網路無法使用。 |
備註
注意
winnetwk.h 標頭會將 WNetGetResourceInformation 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | winnetwk.h |
程式庫 | Mpr.lib |
Dll | Mpr.dll |