IAgentCharacterEx::GetActive

[Microsoft エージェントは Windows 7 の時点で非推奨となり、以降のバージョンの Windows では使用できない場合があります。]

HRESULT GetActive(
   short * psState  // address of active state setting
);

クライアント アプリケーションが文字のアクティブなクライアントであるかどうかを取得し、文字が一番上にあるかどうかを取得します。

• 操作が成功したことを示すS_OKを返します。

psState

状態設定に対して次のいずれかの値を受け取る変数のアドレス。

値	説明
const unsigned shortACTIVATE_NOTACTIVE = 0;	クライアントが文字のアクティブなクライアントではありません。
const unsigned shortACTIVATE_ACTIVE = 1;	クライアントは、文字のアクティブなクライアントです。
const unsigned shortACTIVATE_INPUTACTIVE = 2;	クライアントが入力アクティブ (一番上の文字のアクティブなクライアント) です。

この設定では、ユーザーが文字のアクティブなクライアントであるか、文字が入力アクティブ文字であるかを知ることができます。 複数のクライアント アプリケーションが同じ文字を共有する場合、その文字のアクティブなクライアントはマウス入力を受け取ります (たとえば、Microsoft Agent コントロールのクリックイベントやドラッグ イベント)。 同様に、複数の文字が表示されると、一番上の文字 (入力アクティブ クライアントとも呼ばれます) のアクティブなクライアントは IAgentNotifySink::Command イベントを受け取ります。

Activate メソッドを使用して、アプリケーションが文字のアクティブなクライアントであるかどうかを設定するか、アプリケーションを入力アクティブ クライアントにするかを設定します (文字も最上位になります)。

参照

IAgentCharacter::Activate、 IAgentNotifySinkEx::ActiveClientChange