Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
SQL.SetParamDefault
Sets the default value for this parameter.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
SQL | 2.6 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "SQL.SetParamDefault"; Command; Param ) More
Parameters
Parameter | Description | Example |
---|---|---|
Command | The command reference number gained with SQL.NewCommand. | $Command |
Param | The parameter name or ID. Pass number for ID, a text with parameter name or the index with # prefix. e.g. "#0" for first parameter. | "1" |
Result
Returns "OK" or error message.
Description
Sets the default value for this parameter.Forces DBMS API to use the default parameter value as the input value for an input or input/output parameter in a procedure.
If DBMS API does not support the concept of "default parameter values" in stored procedures, this setting will be ignored.
If you set this flag for the parameter that doesn't have a default value, the effect is DBMS defined (e.g. an error can be returned or NULL can be bound).
To cancel using the default parameter value you should call any other SetParam* function to bind a parameter value.
To check whether this flag is set or not use SQL.GetParamIsDefault method.
See also
This function is free to use.
Created 18th August 2014, last changed 13th January 2015