IPortableDeviceManager::GetDeviceDescription メソッド (portabledeviceapi.h)
デバイスの説明を取得します。
構文
HRESULT GetDeviceDescription(
[in] LPCWSTR pszPnPDeviceID,
[in, out] WCHAR *pDeviceDescription,
[in, out] DWORD *pcchDeviceDescription
);
パラメーター
[in] pszPnPDeviceID
デバイスのプラグ アンド プレイ ID を含む null で終わる文字列へのポインター。 現在接続されているデバイスのプラグ アンド プレイ名の一覧を取得するには、GetDevices を呼び出します。
[in, out] pDeviceDescription
デバイスのユーザー説明名を保持する呼び出し元によって割り当てられたバッファー。 呼び出し元は、このパラメーターのメモリを割り当てる必要があります。 このパラメーターに必要なサイズを確認するには、最初にこのパラメーターを NULL に設定し、 pcchDeviceDescription を 0 に設定してこのメソッドを呼び出します。メソッドは成功し、終了文字を含むデバイスフレンドリ名を保持するために必要なバッファー サイズに pcchDeviceDescription を設定します。
[in, out] pcchDeviceDescription
pDeviceDescription の文字数 (終了文字を含まない)。 入力時の pDeviceDescription の最大長。出力時に、 pDeviceDescription で返される文字列の長さ。
戻り値
このメソッドは HRESULT を返します。 有効な値を次の表に示しますが、これ以外にもあります。
リターン コード | 説明 |
---|---|
|
指定されたバッファーは、デバイスの説明を保持するのに十分な大きさではありません。 (必要なサイズについては、 pcchDeviceDescription で返される値を参照してください)。 |
|
デバイスの説明が見つかりませんでした。 |
|
メソッドが成功しました。 |
|
必要な引数の少なくとも 1 つが NULL ポインターでした。 |
要件
要件 | 値 |
---|---|
対象プラットフォーム | Windows |
ヘッダー | portabledeviceapi.h |
Library | PortableDeviceGUIDs.lib |