IAgentNotifySinkEx::HelpComplete

[Microsoft 에이전트는 Windows 7을 기준으로 더 이상 사용되지 않으며 이후 버전의 Windows에서는 사용할 수 없습니다.]

HRESULT HelpComplete(
   long dwCharID,     // character ID
   long dwCommandID,  // command ID
   long dwCause       // cause 
);

사용자가 도움말 모드를 완료하기 위해 명령 또는 문자를 선택할 때 클라이언트 애플리케이션에 알 수 있습니다.

• 반환 값이 없습니다.

dwCharID

도움말 모드가 완료된 문자의 식별자입니다.

dwCommandID

사용자가 선택한 명령의 식별자입니다.

dwCause

이벤트의 원인이며 다음 값일 수 있습니다.

값	설명
const unsigned shortCSHELPCAUSE_COMMAND = 1;	사용자가 애플리케이션에서 제공하는 명령을 선택했습니다.
const unsigned shortCSHELPCAUSE_OTHERPROGRAM = 2;	사용자가 다른 클라이언트의 Commands 개체를 선택했습니다.
const unsigned shortCSHELPCAUSE_OPENCOMMANDSWINDOW = 3;	사용자가 음성 명령 열기 명령을 선택했습니다.
const unsigned shortCSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;	사용자가 음성 명령 닫기 명령을 선택했습니다.
const unsigned shortCSHELPCAUSE_SHOWCHARACTER = 5;	사용자가 CharacterName 표시 명령을 선택했습니다.
const unsigned shortCSHELPCAUSE_HIDECHARACTER = 6;	사용자가 CharacterName 숨기기 명령을 선택했습니다.
const unsigned shortCSHELPCAUSE_CHARACTER = 7;	사용자가 문자를 선택(클릭)했습니다.

일반적으로 도움말 모드는 사용자가 문자를 클릭하거나 끌거나 문자의 팝업 메뉴에서 명령을 선택할 때 완료됩니다. 화면의 다른 문자나 다른 문자를 클릭하면 도움말 모드가 취소되지 않습니다. 문자에 대한 도움말 모드를 설정한 클라이언트는 IAgentCharacter::HelpModeOn 을 False로 설정하여 도움말 모드를 취소할 수 있습니다. IAgentNotifySinkEx::HelpComplete 이벤트를 트리거하지 않습니다.

사용자가 도움말 모드의 문자 팝업 메뉴에서 명령을 선택하면 서버는 메뉴를 제거하고 명령의 지정된 HelpContextID에 대한 도움말을 호출하고 이 이벤트를 보냅니다. 컨텍스트 구분(이 내용이라고도 함) 도움말 창이 포인터 위치에 표시됩니다. 사용자가 음성 입력으로 명령을 선택하면 도움말 창이 문자 위에 표시됩니다. 문자가 화면 을 벗어나면 창이 캐릭터의 현재 위치에 가장 가까운 화면에 표시됩니다.

서버가 dwCommandID 를 빈 문자열("")로 반환하는 경우 사용자가 서버 제공 명령을 선택했음을 나타냅니다.

이 이벤트는 문자를 도움말 모드로 배치하는 클라이언트 애플리케이션으로만 전송됩니다.

참고 항목

IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName, IAgentCharacterEx::SetHelpContextID, IAgentCommandsEx::SetHelpContextID