IAgentCommandWindow

IAgentCommandWindow defines an interface that allows applications to set and query the properties of the Commands Window. The Commands Window is a shared resource primarily designed for allowing users to view voice-enabled commands. If speech recognition is disabled or not installed, the Commands Window is not accessible. Attempting to set or query its properties will result in an error.

Methods in Vtable Order

IAgentCommandWindow Methods	Description
SetVisible	Sets the value of the Visible property of the Commands Window.
GetVisible	Returns the value of the Visible property of the Commands Window.
GetPosition	Returns the position of the Commands Window.
GetSize	Returns the size of the Commands Window.

IAgentCommandWindow::GetPosition

HRESULT GetPosition(
   long * plLeft,  // address of variable for left-edge of Commands Window
   long * plTop    // address of variable for top-edge of Commands Window
);

Retrieves the Commands Windows' position.

Returns S_OK to indicate the operation was successful.

plLeft

Address of a variable that receives the screen coordinate of the left edge of the Commands Window in pixels, relative to the screen origin (upper left).

plTop

Address of a variable that receives the screen coordinate of the top edge of the Commands Window in pixels, relative to the screen origin (upper left).

See also IAgentCommandWindow::GetSize

IAgentCommandWindow::GetSize

HRESULT GetSize(
   long * plWidth,  // address of variable for Commands Window width
   long * plHeight  // address of variable for Commands Window height
);

Retrieves the current size of the Commands Window.

Returns S_OK to indicate the operation was successful.

plWidth

Address of a variable that receives the width of the Commands Window in pixels, relative to the screen origin (upper left).

plHeight

Address of a variable that receives the height of the Commands Window in pixels, relative to the screen origin (upper left).

See also IAgentCommandWindow::GetPosition

IAgentCommandWindow::GetVisible

HRESULT GetVisible(
   long * pbVisible  // address of variable for Visible setting for 
);                   // Commands Window

Determines whether the Commands Window is visible or hidden.

Returns S_OK to indicate the operation was successful.

pbVisible

Address of a variable that receives TRUE if the Commands Window is visible, or FALSE if hidden.

See also IAgentCommandWindow::SetVisible

IAgentCommandWindow::SetVisible

HRESULT SetVisible(
   long bVisible  // Commands Window Visible setting 
);

Set the Visible property for the Commands Window.

Returns S_OK to indicate the operation was successful.

bVisible

Visible property setting. A value of TRUE displays the Commands Window; FALSE hides it.

The user can override this property.

See also IAgentCommandWindow::GetVisible