Edit

Share via

IAgentCharacter::Show

  • Article

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

HRESULT Show(
   long bFast,      // play Showing state animation flag
   long * pdwReqID  // address of request ID
);

Displays a character.

  • Returns S_OK to indicate the operation was successful. When the function returns, pdwReqID contains the ID of the request.

bFast

Showing state animation flag. If this parameter is True, the Showing state animation plays after making the character visible; if False, the animation does not play.

pdwReqID

Address of a variable that receives the Show request ID.

Avoid setting the bFast parameter to True without playing an animation beforehand, otherwise, the character frame may be displayed, but have no image to display. In particular, note that if you call MoveTo when the character is not visible, it does not play any animation. Therefore, if you call the Show method with bFast set to True, no image will be displayed. Similarly, if you call Hide, then Show with bFast set to True, there will be no visible image.

When using the HTTP protocol to access character and animation data, use the Prepare method to ensure the availability of the Showing state animation before calling this method.

See Also

IAgentCharacter::Hide