IPortableDeviceManager::GetDeviceDescription 方法 (portabledeviceapi.h)
擷取裝置的描述。
語法
HRESULT GetDeviceDescription(
[in] LPCWSTR pszPnPDeviceID,
[in, out] WCHAR *pDeviceDescription,
[in, out] DWORD *pcchDeviceDescription
);
參數
[in] pszPnPDeviceID
包含裝置 隨插即用 標識碼之 Null 終止字串的指標。 您可以呼叫 GetDevices 來擷取目前連線之裝置 隨插即用 名稱的清單。
[in, out] pDeviceDescription
呼叫端配置的緩衝區,用來保存裝置的使用者描述名稱。 呼叫端必須配置此參數的記憶體。 若要瞭解此參數的必要大小,請先呼叫此方法,並將此參數設定為 NULL , 並將 pcchDeviceDescription 設定為 0;方法會成功,並將 pcchDeviceDescription 設定為必要的緩衝區大小,以保存裝置易記名稱,包括終止字元。
[in, out] pcchDeviceDescription
pDeviceDescription 中的字元數 (不包含終止字元) 。 在輸入上, pDeviceDescription 的最大長度;在輸出上, pDeviceDescription 中傳回字串的長度。
傳回值
方法會傳回 HRESULT。 可能的值包括 (但不限於) 下表中的這些值。
傳回碼 | Description |
---|---|
|
提供的緩衝區不夠大,無法保存裝置描述。 (如需所需的 size.) ,請參閱 pcchDeviceDescription 中傳回的值 |
|
找不到裝置描述。 |
|
此方法已成功。 |
|
至少有一個必要的自變數是 NULL 指標。 |
規格需求
需求 | 值 |
---|---|
目標平台 | Windows |
標頭 | portabledeviceapi.h |
程式庫 | PortableDeviceGUIDs.lib |