AdsGetScope

Advantage Client Engine

Retrieves the specified scope from the given index order.

Syntax

UNSIGNED32

AdsGetScope (ADSHANDLE hIndex,

UNSIGNED16 usScopeOption,

UNSIGNED8 *pucScope,

UNSIGNED16 *pusBufLen);

Parameters

hIndex (I)

Handle of index order.

usScopeOption (I)

Indicates which scope value to retrieve. Options are ADS_TOP, ADS_BOTTOM.

pucScope (O)

Return the specified scope in this buffer.

pusBufLen (I/O)

Length of given buffer on input, length of returned data on output. 

Special Return Codes

AE_NO_SCOPE

No scope was set, so a scope cannot be returned or cleared.

Remarks

AdsGetScope returns the indicated scope setting in the form of an index key. The value sent in a call to AdsSetScope was converted to a valid index key by the Advantage Client Engine. It may be necessary to convert the key to another form to make it useful. For example, when an application sets a scope on a date index, the Advantage Client Engine converts the date value to match the key data type. For a CDX and ADI indexes, this would be an 8-byte Julian date representation.

Example

Click Here

See Also

AdsClearScope

AdsSetScope