AdsSetShort

Advantage Client Engine

Stores the given signed short (two byte) integer in the given field

Syntax

UNSIGNED32

AdsSetShort (ADSHANDLE hObj,

UNSIGNED8 *pucFldName,

SIGNED16 sValue);

Parameters

hObj (I)

Handle of table, cursor, statement, or index order.

pucFldName (I)

Name of field to set.

sValue (I)

Short value to be stored in table.

Remarks

AdsSetShort can be used to set values for numeric, long integer, short integer, double, and CurDouble, RowVersion, and Money fields. If there are decimals in a numeric field, the decimals are padded with character zeros. If the number of sValue is too large to fit in a numeric field, ADS_DATA_TOO_LONG is returned.

If the handle passed is an index order handle, the logical record buffer of the index order is modified instead of the table data. The logical record buffer of the index order can be used to build a raw index key in conjunction with calls to AdsInitRawKey and AdsBuildRawKey.

When passed a statement handle this API can be used to specify parameters in an SQL statement previously prepared with a call to AdsPrepareSQL. For this usage pass pucFieldName as either the name of the parameter (when using named parameters) or the number of the parameter (when using either named or unnamed parameters). Parameter numbers in SQL statements are assigned left to right and utilize a one-based counter. For example, in the statement "SELECT * FROM test WHERE :lname = :value" the lname parameter could be referenced either as "lname" or as parameter 1. Using the same logic the value parameter could be referenced either as "value" or as parameter 2.

The pucFldName parameter can be passed as the field name itself or as the one-based integer field position. To pass an integer field position for the pucFldName parameter, use the ADSFIELD macro that is defined in ACE.H. For example, to specify the first field in the table, pass ADSFIELD(1) for the pucFldName parameter; to specify the second field in the table, pass ADSFIELD(2) for the pucFldName parameter; etc.

Example 1

AdsPrepareSQL( hStatement,

"SELECT * FROM test WHERE empid = :IdParam" );

AdsSetShort( hStatement, "IdParam", 5 );

AdsExecuteSQL( hStatement, &hCursor);

When using unnamed parameters these parameters MUST be referenced using their parameter number.

Example 2

AdsPrepareSQL( hStatement,

"SELECT * FROM test WHERE empid = :IdParam" );

AdsSetShort( hStatement, ADSFIELD(1), 5 );

AdsExecuteSQL( hStatement, &hCursor);

Example 3

Additional Example

See Also

AdsGetShort

AdsSetField

AdsInitRawKey

AdsBuildRawKey

AdsPrepareSQL