IPortableDeviceManager::GetDeviceFriendlyName 方法 (portabledeviceapi.h)
擷取裝置的用戶易記名稱。
語法
HRESULT GetDeviceFriendlyName(
[in] LPCWSTR pszPnPDeviceID,
[in, out] WCHAR *pDeviceFriendlyName,
[in, out] DWORD *pcchDeviceFriendlyName
);
參數
[in] pszPnPDeviceID
包含裝置 隨插即用 標識碼之 Null 終止字串的指標。 您可以藉由呼叫 GetDevices 來擷取連線到電腦之所有裝置 隨插即用 名稱的清單。
[in, out] pDeviceFriendlyName
呼叫端配置的緩衝區,用來保存裝置的用戶易記名稱。 若要瞭解此參數的必要大小,請先呼叫這個方法,並將此參數設定為 NULL ,並將 pcchDeviceFriendlyName 設定為 0;方法會成功,並將 pcchDeviceFriendlyName 設定為所需的緩衝區大小,以保存裝置易記的名稱,包括終止字元。
[in, out] pcchDeviceFriendlyName
在輸入時, pDeviceFriendlyName 可以保存的最大字元數,包括終止字元。 輸出時, pDeviceFriendlyName 所傳回的字元數,也包含終止字元。
傳回值
方法會傳回 HRESULT。 可能的值包括 (但不限於) 下表中的這些值。
傳回碼 | Description |
---|---|
|
提供的緩衝區不夠大,無法保存裝置描述。 (參考 在pcchDeviceDescription 中針對所需的size.) 傳回的值 |
|
找不到裝置描述。 |
|
此方法已成功。 |
|
至少其中一個必要自變數是 NULL 指標。 |
備註
不支援此方法不需要裝置。 如果此方法無法擷取名稱,請嘗試要求裝置物件的 WPD_OBJECT_NAME 屬性, (標識符為 WPD_DEVICE_OBJECT_ID) 的物件。
規格需求
需求 | 值 |
---|---|
目標平台 | Windows |
標頭 | portabledeviceapi.h |
程式庫 | PortableDeviceGUIDs.lib |