| Stonefield Query SDK |
| Application Object |
Properties
| Name | Data Type | Description |
|---|---|---|
| ApplicationDataDirectory | String | The path for Stonefield Query's data files, such as the users and roles tables. |
| ApplicationDirectory | String | The path for the Stonefield Query program files. |
| ApplicationName | String | The name assigned to the Stonefield Query project. This is the value specified in the Application Name configuration setting. |
| CalledFromProxy | Boolean | True if Stonefield Query is being run from the SQProxy object, False if not. This allows your scripts to use different behavior, such as not displaying dialogs, in that case. |
| CanEditReports | Boolean | True if the user can add or edit reports, False if not. |
| DataEngine | Object | A reference to the DataEngine object. |
| Parameters | Object | A reference to the Parameters collection. |
| ProjectDirectory | String | The path for the open project's configuration files. |
| ReportsDirectory | String | The path for the reports files. |
| ReportEngine | Object | A reference to the ReportEngine object. |
| SerialNumber | String | The serial number for the current license. |
| ShortApplicationName | String | The abbreviated name assigned to the Stonefield Query project. This is the value specified in the Short Application Name configuration setting. |
| TargetApplicationDirectory | String | The target application's program directory. This value is blank if the Need Target Application Directory configuration setting is False. |
| TimeZoneDesc | String | Contains the descriptive name of the local time zone. |
| TimeZoneOffset | Integer | Contains the offset for the local time zone from GMT in seconds (it even accounts for daylight saving time). This can be used to display local time from fields containing GMT time. |
| Users | Object | A reference to the Users collection. |
| Version | String | The Stonefield Query version number. |
Methods
| Name | Description |
|---|---|
| AddProperty | Adds a property to the Application object. |
| Decrypt | Decrypts a string. |
| Encrypt | Encrypts a string. |
| Execute | Executes an application. |
| GetDataSetFieldName | Returns the name of a field as it appears in the data set for a report. |
| GetINIValue | Reads a value from the specified INI file. |
| GetRegistryValue | Reads a value from the Windows Registry. |
| GetValuesCollection | Returns a values collection object. |
| PromptUserForValue | Asks the user for a value. |
| SetINIValue | Writes a value to the specified INI file. |
| SetRegistryValue | Saves a value in the Windows Registry. |
| SetViewerLicenses | Sets the number of viewer licenses available. |
| ShowErrorMessage | Displays an error message, similar to the MESSAGEBOX() function. |
| ShowStatus | Displays a message in the Reports Explorer status bar. |
| Shutdown | Terminates the Stonefield Query session. |
| UpdateProgressBar | Updates the value of the progress bar in the Reports Explorer status bar. |
| Last Updated: 05/25/12 |