FileOpen

The FileOpen method opens a specified text file containing a SQL query.

Syntax

[Result=] aaHistClientQuery.FileOpen(message fileName);

Parameters

fileName

The full path to the file.

Remarks

When this method is called, it automatically sets the query type to Custom. If the SQL tab is active at the time the method is called, the method loads the SQL query from the file into the SQL tab, but does not send it to the server. If the Data tab is active, the method loads the query into the SQL tab, sends it to the currently selected server, and shows the results on the Data tab.

Return Value

Returns True if the file can be opened successfully; otherwise returns False (for example, if no file name is specified or the specified file does not exist).