IAgentCharacter::GetMoveCause

[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]

HRESULT GetMoveCause(
   long * pdwCause  // address of variable for cause of character move
);

Retrieves the cause of the character's last move.

• Returns S_OK to indicate the operation was successful.

pdwCause

Address of a variable that receives the cause of the character's last move and will be one of the following:

Value	Description
const unsigned short NeverMoved = 0;	Character has not been moved.
const unsigned short UserMoved = 1;	User dragged the character.
const unsigned short ProgramMoved = 2;	Your application moved the character.
const unsigned short OtherProgramMoved = 3;	Another application moved the character.
const unsigned short SystemMoved = 4	The server moved the character to keep it onscreen after a screen resolution change.

See Also

IAgentNotifySink::Move