メインコンテンツへスキップ
入力デバイスのフレンドリ表示名を UTF-8 文字列として取得します。

構文

パラメーター

bufferByteCount   _In_
型: uint32_t
buffer が指すバッファーのサイズ (バイト単位)。必要なサイズを照会するには 0 を渡します。 buffer   _Out_writes_bytes_opt_(bufferByteCount)
型: char*
null で終わる UTF-8 の表示名を受け取るバッファー。必要なサイズを照会するには nullptr を渡します。

戻り値

型: uint32_t 表示名を格納するために必要なバッファーのサイズ (null 終端文字を含む、バイト単位)。

解説

このメソッドは、buffer が nullptr ではなく、bufferByteCount が必要なサイズ以上の場合にのみ、表示名を buffer に書き込みます。それ以外の場合、バッファーは変更されません。表示名を取得するには、まず bufferByteCount に 0、buffer に nullptr を指定してメソッドを呼び出して必要なサイズを取得し、そのサイズのバッファーを割り当ててから、もう一度メソッドを呼び出します。 デバイスに表示名がない場合、必要なサイズは 1 になり、メソッドは空の文字列を書き込みます。 表示名は、デバイスの “フレンドリ” 名です。アプリケーションの UI に表示できますが、ローカライズされている保証はありません。GameInput はこの文字列を複数の場所から検索し、最終的なフォールバックの 1 つはデバイスのファームウェアです。 表示名は、デバイス オブジェクトの有効期間中は変化しません。 次の例では、デバイスの表示名を取得します。
GameInput v3 以前では、この情報は IGameInputDevice::GetDeviceInfo から返される GameInputDeviceInfo 構造体の displayName メンバーから取得できました。

要件

ヘッダー: GameInput.h ライブラリ: gameinput.lib サポートされているプラットフォーム: Windows、XBOX One ファミリー本体、XBOX Series 本体

関連項目

GameInput の概要
IGameInputDevice
IGameInputDevice::GetPnpPath

バージョン履歴

最終更新日 2026年11月6日