AdsSetString

Advantage Client Engine

Sets a field value in a table to a string value.

Syntax

UNSIGNED32

AdsSetString (ADSHANDLE hObj,

UNSIGNED8 *pucFldName,

UNSIGNED8 *pucBuf,

UNSIGNED32 ulLen);

Parameters

hObj (I)

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

pucFldName (I)

Name of field to set.

pucBuf (I)

Store this data in the field.

ulLen (I)

Length of data in the buffer.

Special Return Codes

AE_DATA_TRUNCATED

The data given was too long to fit in the field. The data was truncated to fit.

Remarks

AdsSetString can be used to set values for character, memo, and logical fields. To set numeric and date fields with string values, use AdsSetField. Be sure to be precise with the ulLen parameter, or unwanted data could be copied into a field.

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 lastname = :lname AND firstname = : fname" );

AdsSetString( hStatement, "lname", "Anderson", strlen("Anderson") );

AdsSetString( hStatement, ADSFIELD(2), "John", strlen("John") );

AdsExecuteSQL( hStatement, &hCursor);

 

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

Example 2

AdsPrepareSQL( hStatement,

"SELECT * FROM test WHERE lastname = :lname AND firstname = : fname" );

AdsSetString( hStatement, ADSFIELD(1), "Anderson",

strlen("Anderson") );

AdsSetString( hStatement, ADSFIELD(2), "John", strlen("John") );

AdsExecuteSQL( hStatement, &hCursor);

Example 3

Additional Example

See Also

AdsGetString

AdsSetField

AdsInitRawKey

AdsBuildRawKey

AdsPrepareSQL