Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
SQL.GetCommandOption
Gets a string value of a specific command option.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
SQL | 2.6 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "SQL.GetCommandOption"; Command; Key ) More
Parameters
Parameter | Description | Example |
---|---|---|
Command | The command reference number gained with SQL.NewCommand. | $Command |
Key | A string key of the command option. | "" |
Result
Returns value or error message.
Description
Gets a string value of a specific command option.Call this method to get value(s) of server specific command options. See Server specific notes.
A command related option may be specified in either connection object or SACommand object. If it is specified in connection object it affects all the commands on that connection.
If an option is not specially assigned to the command object the Library takes this option from related connection object (see SQL.GetConnectionOption method). If an option is not specified in neither command nor connection objects, the Library takes the default option value.
see also
https://www.sqlapi.com/ApiDoc/class_s_a_command.html
See also
Release notes
- Version 8.4
- Added SQL.GetCommandOptions, SQL.GetConnectionOptions, SQL.GetFieldOptions and SQL.GetParamOptions functions to query options list.
This function is free to use.
Created 18th August 2014, last changed 10th January 2020