Skip to content

document functions #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

document functions #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4eedafc
document code
davecramer Jun 12, 2025
7c9349a
more documentation
davecramer Jun 16, 2025
73148e6
Merge branch 'main' into fix_desc_rec
davecramer Jun 16, 2025
c7d73cb
remove some extraneous comments
davecramer Jun 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 143 additions & 7 deletions odbcapi30.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,35 @@ SQLGetDescField(SQLHDESC DescriptorHandle,
return ret;
}

/* new function */
/*
* SQLGetDescRec
*
* Description:
* This function retrieves the current settings or values of fields in a descriptor record.
* It's the ANSI version of the function that works with descriptor records.
*
* Parameters:
* DescriptorHandle - Handle to the descriptor
* RecNumber - The descriptor record number (1-based)
* Name - Buffer to store the descriptor name (ANSI)
* BufferLength - Length of the Name buffer in bytes
* StringLength - Pointer to store the actual length of the name
* Type - Pointer to store the SQL data type
* SubType - Pointer to store the data type subcode
* Length - Pointer to store the data length
* Precision - Pointer to store the numeric precision
* Scale - Pointer to store the numeric scale
* Nullable - Pointer to store the nullability attribute
*
* Returns:
* SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE
*
* Comments:
* This function is a thin wrapper around PGAPI_GetDescRec, which contains
* the actual implementation. Unlike the wide-character version (SQLGetDescRecW),
* this function doesn't need to perform character set conversion since it
* works directly with ANSI strings.
*/
RETCODE SQL_API
SQLGetDescRec(SQLHDESC DescriptorHandle,
SQLSMALLINT RecNumber, SQLCHAR *Name,
Expand All @@ -326,9 +354,11 @@ SQLGetDescRec(SQLHDESC DescriptorHandle,

MYLOG(0, "Entering h=%p rec=%d name=%p blen=%d\n", DescriptorHandle, RecNumber, Name, BufferLength);
MYLOG(0, "str=%p type=%p sub=%p len=%p prec=%p scale=%p null=%p\n", StringLength, Type, SubType, Length, Precision, Scale, Nullable);

ret = PGAPI_GetDescRec(DescriptorHandle, RecNumber, Name, BufferLength,
StringLength, Type, SubType, Length, Precision,
Scale, Nullable);

return ret;
}

Expand Down Expand Up @@ -416,7 +446,28 @@ SQLGetConnectAttr(HDBC ConnectionHandle,
return ret;
}

/* SQLGetStmtOption -> SQLGetStmtAttr */
/*
* SQLGetStmtAttr
*
* Description:
* This function retrieves the current setting of a statement attribute.
* This is the ANSI version of the function.
*
* Parameters:
* StatementHandle - Handle to the statement
* Attribute - The attribute to retrieve (SQL_ATTR_* constant)
* Value - Buffer to store the attribute value
* BufferLength - Length of the Value buffer in bytes
* StringLength - Pointer to store the actual length of string data
*
* Returns:
* SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE
*
* Comments:
* This function replaces the deprecated SQLGetStmtOption function.
* It provides thread-safe access to statement attributes by using
* critical sections to protect shared resources.
*/
RETCODE SQL_API
SQLGetStmtAttr(HSTMT StatementHandle,
SQLINTEGER Attribute, PTR Value,
Expand All @@ -426,13 +477,20 @@ SQLGetStmtAttr(HSTMT StatementHandle,
StatementClass *stmt = (StatementClass *) StatementHandle;

MYLOG(0, "Entering Handle=%p " FORMAT_INTEGER "\n", StatementHandle, Attribute);

ENTER_STMT_CS(stmt);

SC_clear_error(stmt);

StartRollbackState(stmt);

ret = PGAPI_GetStmtAttr(StatementHandle, Attribute, Value,
BufferLength, StringLength);
ret = DiscardStatementSvp(stmt,ret, FALSE);

ret = DiscardStatementSvp(stmt, ret, FALSE);

LEAVE_STMT_CS(stmt);

return ret;
}

Expand All @@ -455,7 +513,27 @@ SQLSetConnectAttr(HDBC ConnectionHandle,
return ret;
}

/* new function */
/*
* SQLSetDescField
*
* Description:
* This function sets the value of a field in a descriptor record.
* This is the ANSI version of the function.
*
* Parameters:
* DescriptorHandle - Handle to the descriptor
* RecNumber - The descriptor record number (1-based, 0 for header fields)
* FieldIdentifier - The field identifier (SQL_DESC_* constant)
* Value - The value to set for the field
* BufferLength - Length of the Value buffer in bytes (for string data)
*
* Returns:
* SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE
*
* Comments:
* This function simply passes through to the core implementation function
* PGAPI_SetDescField without any additional processing.
*/
RETCODE SQL_API
SQLSetDescField(SQLHDESC DescriptorHandle,
SQLSMALLINT RecNumber, SQLSMALLINT FieldIdentifier,
Expand All @@ -464,12 +542,39 @@ SQLSetDescField(SQLHDESC DescriptorHandle,
RETCODE ret;

MYLOG(0, "Entering h=%p rec=%d field=%d val=%p\n", DescriptorHandle, RecNumber, FieldIdentifier, Value);

ret = PGAPI_SetDescField(DescriptorHandle, RecNumber, FieldIdentifier,
Value, BufferLength);

return ret;
}

/* new function */
/*
* SQLSetDescRec
*
* Description:
* This function sets multiple descriptor fields with a single call.
* This is the ANSI version of the function.
*
* Parameters:
* DescriptorHandle - Handle to the descriptor
* RecNumber - The descriptor record number (1-based)
* Type - SQL data type
* SubType - Datetime or interval subcode
* Length - Maximum data length
* Precision - Precision of numeric types
* Scale - Scale of numeric types
* Data - Pointer to data buffer
* StringLength - Pointer to buffer length
* Indicator - Pointer to indicator variable
*
* Returns:
* SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE
*
* Comments:
* This function provides a more efficient way to set multiple descriptor
* fields that are commonly used together.
*/
RETCODE SQL_API
SQLSetDescRec(SQLHDESC DescriptorHandle,
SQLSMALLINT RecNumber, SQLSMALLINT Type,
Expand All @@ -482,9 +587,11 @@ SQLSetDescRec(SQLHDESC DescriptorHandle,

MYLOG(0, "Entering h=%p rec=%d type=%d sub=%d len=" FORMAT_LEN " prec=%d scale=%d data=%p\n", DescriptorHandle, RecNumber, Type, SubType, Length, Precision, Scale, Data);
MYLOG(0, "str=%p ind=%p\n", StringLength, Indicator);

ret = PGAPI_SetDescRec(DescriptorHandle, RecNumber, Type,
SubType, Length, Precision, Scale, Data,
StringLength, Indicator);

return ret;
}
#endif /* UNICODE_SUPPORTXX */
Expand Down Expand Up @@ -550,7 +657,27 @@ SQLSetEnvAttr(HENV EnvironmentHandle,
}

#ifndef UNICODE_SUPPORTXX
/* SQLSet(Param/Scroll/Stmt)Option -> SQLSetStmtAttr */
/*
* SQLSetStmtAttr
*
* Description:
* This function sets the current setting of a statement attribute.
* This is the ANSI version of the function.
*
* Parameters:
* StatementHandle - Handle to the statement
* Attribute - The attribute to set (SQL_ATTR_* constant)
* Value - The value to set for the attribute
* StringLength - Length of the Value buffer in bytes (for string data)
*
* Returns:
* SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE
*
* Comments:
* This function replaces the deprecated SQLSetStmtOption function.
* It provides thread-safe access to statement attributes by using
* critical sections to protect shared resources.
*/
RETCODE SQL_API
SQLSetStmtAttr(HSTMT StatementHandle,
SQLINTEGER Attribute, PTR Value,
Expand All @@ -560,12 +687,21 @@ SQLSetStmtAttr(HSTMT StatementHandle,
RETCODE ret;

MYLOG(0, "Entering Handle=%p " FORMAT_INTEGER "," FORMAT_ULEN "\n", StatementHandle, Attribute, (SQLULEN) Value);

ENTER_STMT_CS(stmt);

SC_clear_error(stmt);

StartRollbackState(stmt);

/* Call the core implementation function */
ret = PGAPI_SetStmtAttr(StatementHandle, Attribute, Value, StringLength);
ret = DiscardStatementSvp(stmt,ret, FALSE);

/* Handle transaction state and cleanup */
ret = DiscardStatementSvp(stmt, ret, FALSE);

LEAVE_STMT_CS(stmt);

return ret;
}
#endif /* UNICODE_SUPPORTXX */
Expand Down
Loading