4D Doc Center : ODBC_SQLSetCursorName

Home

4D v14.1

ODBC_SQLSetCursorName


ODBC_SQLSetCursorName ( stmtID ; cursorName ) -> Function result

Parameter	Type	Description
stmtID	Longint	Statement ID
cursorName	String	Name of the cursor to set
Function result	Longint	Returns the result of the MS ODBC API function SQLSetCursorName

Description

The ODBC_SQLSetCursorName command associates a cursor name with an active statement. If this command is not called, the driver generates cursor names needed for SQL statement processing.

For efficient processing, the cursor name should not include any leading or trailing spaces, and if the cursor name includes a delimited identifier, the delimiter should be positioned as the first character in the cursor name. Cursor names are used only in positioned update and delete statements and should not exceed 18 characters in length.

If the SQL statement is a SELECT statement and if you set a cursor name with a statement, then the driver uses the specified cursor. Otherwise, the driver generates a cursor name.

stmtID is a valid statement ID returned by ODBC_SQLAllocStmt.

cursorName is the name of the cursor that was previously set by ODBC_SQLSetCursorName.

For more information, please see the SQLSetCursorName function in the MS ODBC API Reference at http://msdn.microsoft.com/en-us/library/ms711707(VS.85).aspx.

Function Results

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

Example

See the example for the ODBC_SQLGetCursorName command.