Reviewing Commonly-used API Calls

This section provides a quick reference of the most commonly used API calls. Review this information before starting to implement methods.

These methods are in CustomServerBase except where indicated.

For more information, see the API Reference.

Last updated April 08, 2024

Let us know how we can improve your Help Center experience.

AddHandler	Adds an event handler as the first handler of the event.
RecordFunction	Records a step in the test.

GetWndMessageFilter	Called by UFT One to set the Windows message filter.
InitEventListener	Called by UFT One to load event handlers and start listening for events.
OnMessage	Called when UFT One hooks the window message.
ReleaseEventListener	Stops listening for events.

DragAndDrop, KeyDown, KeyUp, MouseClick, MouseDblClick, MouseDown, MouseMove, MouseUp, PressKey, PressNKeys, SendKeys, SendString	Mouse and keyboard simulation methods.
PrepareForReplay	Prepares the control for an action run.
ReplayReportStep	Writes an event to the test report.
ReplayThrowError	Generates an error message and changes the reported step status.
ShowError	Displays the .NET warning icon.
TestObjectInvokeMethod	Invokes one of the methods exposed by the test object's IDispatch interface.

AddRemoteEventListener	Creates an EventListener instance in the Application under test process.
CreateRemoteObject	Creates an instance of an assistant object in the Application under test process.
GetEventArgs (IEventArgsHelper)	Retrieves and deserializes the EventArgs object.
Init (IEventArgsHelper)	Initializes the EventArguments helper class with an EventArgs object.
InvokeAssistant	Invokes a method of a CustomAssistantBase class in the control's thread.
InvokeCustomServer (EventsListenerBase)	Invokes the Custom Server's methods running in the UFT One process from the Application under test process.
SetTargetControl (CustomAssistantBase)	Attaches to the source custom control by the control's window handle.

ControlGetProperty	Retrieves a property of a control that is not thread-safe.
ControlInvokeMethod	Invokes a method of a control that is not thread-safe.
ControlSetProperty	Sets a property of a control that is not thread-safe.
GetSettingsValue	Gets a parameter value from the settings of this control in the configuration file.
GetSettingsXML	Returns the settings of this control as entered in the configuration file.

GetTableData (VerificationServerBase)	Called by UFT One to retrieve the data in a table.
GetTableRowRange (VerificationServerBase)	Called by UFT One to retrieve the first and last rows of the table.
GetTableColNames (VerificationServerBase)	Called by UFT One to retrieve the names of the table columns.