Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Guides   Examples
New in version: 7.1   7.2   7.3   7.4   7.5   8.0   8.1   8.2   8.3   8.4    Statistic  

SQL.SetCommandText

Sets the command text.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
SQL 2.6 Yes Yes Yes Yes Yes

MBS( "SQL.SetCommandText"; Command; CommandText { ; CommandType } )

Parameters

Parameter Description Example value
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 Optional
Type of command. Can be CmdUnknown, CmdSQLStmt, CmdSQLStmtRaw or CmdStoredProc. CmdUnknown is default.
"CmdSQLStmtRaw"

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:
CmdUnknownCommand type is not defined. Library will detect command type automatically when needed.
CmdSQLStmtCommand is an SQL statement.
CmdSQLStmtRawCommand is an SQL statement that mustn't be interpreted by SQLAPI++.
CmdStoredProcCommand 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

Created 18th August 2014, last changed 13th January 2015


SQL.SetCommandTag   -   SQL.SetConnectionOption

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins