SACommand::Param

SAParam & Param( int  nParamByID );
throw (SAException);

SAParam & Param( const SAString &sParamByName );
throw (SAException);

Returns the command parameter specified by its position or name.

Parameters

nParamByID.    A position of parameter specified in the command text. Normally position is a number stated in the command text after a colon (for example, 1 for :1, 5 for :5).

sParamByName.    A string that represents a name of the requested parameter. Normally name is a string stated in the command text after a colon (for example, 'city' for :city, 'my city' for :"my city") or a parameter name in a stored procedure or function.

Return value

A reference to a SAParam object.

Remarks

Use Param method to access a parameter by its name or position (in SQL statement). If, for example, you want to walk through all the parameters use ParamByIndex method.  

If parameters were not created before calling Param method the Library creates them implicitly (can query native API if needed and therefore can throw exception on error) and then returns the specified parameter. 

Passing a value of name or position which does not specified in the command text will throw an exception.

SAParam object contains full information about a parameter: name, type, size, etc. Values for the input parameters can be assigned to SAParam object or supplied by operator << .

Server specific notes

No specific information.

See also

CreateParam, ParamByIndex, ParamCount

SAParam

Error handling

Problems and Questions

If you haven't found the answer to your questions or have some problems on using the Library, please, send e-mail to howto@sqlapi.com.