CLASS: MSAgent
AUTHOR: NaN
DATE: Sept 24, 2001
DESCRIPTION: This Object creates an Ms Agent COM object. Used for 'speaking' whatever text you send to an instance object of this class

This this class uses COM's and you need to have the following incldudes from Ernie's COM model to properly complile this class:
include \masm32\include\ole32.inc ; Interfacing COM include \masm32\com\include\oaidl.inc ; Used for Coinvoke and others include \masm32\include\oleaut32.inc ; Used for SysAllocString and Varient include \masm32\include\bstrlib.inc ; BSTR functions include \masm32\include\L.inc ; BSTR functions includelib \masm32\lib\ole32.lib ; Interfacing COM includelib \masm32\lib\oleaut32.lib ; COM tools lib includelib \masm32\lib\bstrlib.lib ; The BSTR lib
NOTE: This is text->speech output only, I am still figuring out the Mouse Input Events for this. Future Versions of this class will suport pop-up boxes over the agent character and send WM_COMMAND messages to your client window.

METHOD: CONSTRUCTOR (NONE)
DESCRIPTION: Creates an Agent Instance. It uses the Default Character (Genie) on your system. Future versions will suport other characters. When created the character is NOT shown. You have to instruct it to be shown before sending any text to speak.
RETURN: Handle to MSAgent Object (not COM, but MASM32 OOP object).

METHOD: destructor
DESCRIPTION: Destroys the COM instance. As well as the Global memory allocated with this instance (used for BSTRING conversions).
RETURN: Nothing.

METHOD: getAgent (NONE)
DESCRIPTION: Returns the pIAgentCharacter COM pointer.
RETURN: pIAgentCharacter (COM).

METHOD: Hide ()
DESCRIPTION: Hides the Character, doing its Hide animation.
RETURN: Nothing.

METHOD: Show ()
DESCRIPTION: Shows the Agent Character, doing its show animation.
RETURN: Nothing.

METHOD: Gesture(GCODE)
DESCRIPTION: MultiLine Description. HTML TAGS ALLOWED. End with double period.
GCODE This is the Gesture type. There currently is the following gestures animations to choose from:
AGENT_POS_LEFT AGENT_POS_RIGHT AGENT_POS_UP AGENT_POS_DOWN AGENT_POS_REST AGENT_POS_GREET AGENT_POS_SURPRISED
You should return the Agent to the Rest positon or the character will speak in its last position.
RETURN: Nothing.

METHOD: Speak (lpText)
DESCRIPTION: Speaks the ASCII text found in the lpText parameter. Up to 2Kb is reserved in any one speaking session. 4Kb for UNICODE -> 2Kb of ASCII. NOTE: The character must be shown before speaking or nothing will happen.
lpText This is the pointer to the text to be said.
RETURN: Nothing.

METHOD: ReadClipboard(hWin)
DESCRIPTION: Reads the contents of the clipboard. NOTE: The character must be shown before speaking or nothing will happen.
hWin The handle of the owner window the clipboard should be opended to. True if Read. Flase if not.



MASM Object To HTML Creator V1.0
Copyright ©2001 NaN Software.
NAN32ASM.CJB.NET