IPortableDeviceManager::GetDeviceFriendlyName メソッド (portabledeviceapi.h)

  • [アーティクル]

デバイスのわかりやすい名前を取得します。

構文

HRESULT GetDeviceFriendlyName(
  [in]      LPCWSTR pszPnPDeviceID,
  [in, out] WCHAR   *pDeviceFriendlyName,
  [in, out] DWORD   *pcchDeviceFriendlyName
);

パラメーター

[in] pszPnPDeviceID

デバイスのプラグ アンド プレイ ID を含む null で終わる文字列へのポインター。 GetDevices を呼び出すことで、コンピューターに接続されているすべてのデバイスのプラグ アンド プレイ名の一覧を取得できます。

[in, out] pDeviceFriendlyName

デバイスのわかりやすい名前を保持するために使用される呼び出し元によって割り当てられたバッファー。 このパラメーターに必要なサイズを確認するには、最初にこのパラメーターを NULL に設定し、 pcchDeviceFriendlyName を 0 に設定してこのメソッドを呼び出します。メソッドは成功し、終了文字を含むデバイスフレンドリ名を保持するために必要なバッファー サイズ に pcchDeviceFriendlyName を設定します。

[in, out] pcchDeviceFriendlyName

入力時に、 pDeviceFriendlyName が保持できる最大文字数 (終了文字を含む)。 出力時に、 pDeviceFriendlyName によって返される文字数 (終了文字も含む)。

戻り値

このメソッドは HRESULT を返します。 有効な値を次の表に示しますが、これ以外にもあります。

リターン コード 説明
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)
 指定されたバッファーは、デバイスの説明を保持するのに十分な大きさではありません。 (必要なサイズについては、 pcchDeviceDescription で返される値を参照してください)。
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)
 デバイスの説明が見つかりませんでした。
S_OK
 メソッドが成功しました。
E_POINTER
 必要な引数の少なくとも 1 つが NULL ポインターでした。

注釈

このメソッドをサポートするためにデバイスは必要ありません。 このメソッドで名前の取得に失敗した場合は、デバイス オブジェクトの WPD_OBJECT_NAME プロパティ (ID がWPD_DEVICE_OBJECT_IDのオブジェクト) を要求してみてください。

要件

要件 値
対象プラットフォーム Windows
ヘッダー portabledeviceapi.h
Library PortableDeviceGUIDs.lib

こちらもご覧ください

IPortableDeviceManager インターフェイス

IPortableDeviceManager::GetDevices