| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
SQL.SetCommandText
Sets the command text.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| SQL | 2.6 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "SQL.SetCommandText"; Command; CommandText { ; CommandType } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| Command | The command reference number gained with SQL.NewCommand. | $Command | |
| CommandText | A string that represents command text string (an SQL statement or a stored procedure name). | "SELECT * FROM MyTable" | |
| CommandType | Type of command. Can be CmdUnknown, CmdSQLStmt, CmdSQLStmtRaw or CmdStoredProc. CmdUnknown is default. | "CmdSQLStmtRaw" | Optional |
Result
Returns "OK" or error message.
Description
Sets the command text.Use SQL.setCommandText method to set the command text. Command text can also be set in SQL.NewCommand.
It's not necessary to set a command type explicitly, because it is defined automatically in terms of command text string. But if you still have any reason to do it, use one of the following values:
| CmdUnknown | Command type is not defined. Library will detect command type automatically when needed. |
| CmdSQLStmt | Command is an SQL statement. |
| CmdSQLStmtRaw | Command is an SQL statement that mustn't be interpreted by SQLAPI++. |
| CmdStoredProc | Command is a stored procedure or a function. |
To get command type use SQL.CommandType method.
If the command is an SQL statement and it has parameters, a set of parameter objects creates implicitly.
See also
This function is free to use.
Created 18th August 2014, last changed 13th January 2015
