AX_GetAceStmtHandle()

Advantage Visual Objects RDD

  Previous topic Next topic  

Returns the Advantage Client Engine SQL statement handle that corresponds with the SQL cursor opened in the current work area. The handle can be used to call any Advantage Client Engine API directly. This function only applies to the AXSQL RDDs. For all other RDDs, it will always return zero.

Syntax

AX_GetAceStmtHandle() -> DWORD

Returns

An Advantage Client Engine SQL statement handle

Description

Returns the statement handle associated with the current work area. The handle can be used to call any Advantage Client Engine API directly. The APIs can be imported into Visual Objects from the ACE.AEF file.

The AX_GetAceStmtHandle function gets the statement handle from the current work area. If you are unsure which work area is current, use select() to set it. For example:

select( sqlServer:workarea )

or

select( sqlServer:alias )

To avoid all ambiguity you could also retrieve the statement handle directly from the AdsSQLServer or DBServer object using the Info method. For example:

sqlServer:Info( DBI_GET_ACE_STMT_HANDLE )

DBI_GET_ACE_STMT_HANDLE is defined in the dbfaxs.aef library.