次の方法で共有

IAudioSessionControl::SetIconPath メソッド (audiopolicy.h)

  • [アーティクル]

SetIconPath メソッドは、現在のセッションに表示アイコンを割り当てます。

構文

HRESULT SetIconPath(
  [in] LPCWSTR Value,
  [in] LPCGUID EventContext
);

パラメーター

[in] Value

アイコンを含む .ico、.dll、または .exe ファイルのパスとファイル名を指定する、null で終わるワイド文字列へのポインター。 アイコン パスの詳細については、Windows SDK のドキュメントを参照してください。

[in] EventContext

イベント コンテキスト GUID へのポインター。 このメソッドの呼び出しでアイコン変更イベントが生成された場合、セッション マネージャーは 、セッション マネージャーと IAudioSessionEvents インターフェイスを登録しているすべてのクライアントに通知を送信します。 セッション マネージャーには、通知ごとに EventContext ポインター値が含まれます。 通知を受け取ると、クライアントは EventContext 値を調べることで、そのクライアントまたは別のクライアントがイベントのソースであるかどうかを判断できます。 このスキームは、セッション内のすべてのクライアント間で一意であるこのパラメーターの値を選択するクライアントによって異なります。 呼び出し元がこのパラメーターに NULL ポインターを指定した場合、クライアントの通知メソッドは NULL コンテキスト ポインターを受け取ります。

戻り値

メソッドが成功した場合は、S_OK を返します。 失敗した場合、次の表に示す値が含まれますが、これに限定されません。

リターン コード 説明
E_POINTER
 パラメーター 値 は NULL です。
AUDCLNT_E_DEVICE_INVALIDATED
 オーディオ エンドポイント デバイスが取り外されているか、オーディオ ハードウェアまたは関連するハードウェア リソースが再構成、無効、削除、またはその他の方法で使用できなくなります。
AUDCLNT_E_SERVICE_NOT_RUNNING
 Windows オーディオ サービスが実行されていません。

解説

Windows Vista では、システム提供のプログラム Sndvol.exe は、表示アイコン (表示名と共に) を使用して、セッションのボリューム コントロールにラベルを付けます。 クライアントが SetIconPath を呼び出してセッションにアイコンを割り当てない場合、Sndvol プログラムはアプリケーション ウィンドウのアイコンをセッションの既定のアイコンとして使用します。

クロスプロセス セッションの場合、セッションは 1 つのアプリケーション プロセスに関連付けされません。 したがって、Sndvol には既定で使用するアプリケーション固有のアイコンがないため、クライアントは SetIconPath を呼び出して、意味のないアイコンが表示されないようにする必要があります。

表示アイコンは、 IAudioSessionControl オブジェクトの有効期間を超えて保持されません。 したがって、オブジェクトへのすべての参照が解放されると、その後に作成されたオブジェクトのバージョン (同じアプリケーション、同じセッション GUID、および同じエンドポイント デバイスを含む) は、クライアントが SetIconPath を呼び出すまで、既定のアイコンをもう一度持ちます。

クライアントは、 IAudioSessionControl::GetIconPath メソッドを呼び出すことによって、セッションの表示アイコンを取得できます。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー audiopolicy.h

関連項目

IAudioSessionControl インターフェイス

IAudioSessionControl::GetIconPath