Функция SQLParamData

Соответствие
Представлена версия: соответствие стандартам ODBC 1.0: ISO 92

Сводка
SQLParamData используется вместе с SQLPutData для предоставления данных параметров во время выполнения инструкции и с sqlGetData для получения потоковой выходных данных параметров.

Синтаксис

  
SQLRETURN SQLParamData(  
     SQLHSTMT       StatementHandle,  
     SQLPOINTER *   ValuePtrPtr);  

Аргументы

ОператорHandle
[Входные данные] Дескриптор инструкции.

ValuePtrPtr
[Выходные данные] Указатель на буфер, в котором возвращается адрес буфера ParameterValuePtr, указанного в SQLBindParameter (для данных параметров) или адрес буфера TargetValuePtr, указанного в SQLBindCol (для данных столбцов), как указано в поле записи дескриптора SQL_DESC_DATA_PTR.

Возвраты

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_NEED_DATA, SQL_NO_DATA SQL_STILL_EXECUTING, SQL_ERROR, SQL_INVALID_HANDLE или SQL_PARAM_DATA_AVAILABLE.

Диагностика

Когда SQLParamData возвращает SQL_ERROR или SQL_SUCCESS_WITH_INFO, связанное значение SQLSTATE можно получить путем вызова SQLGetDiagRec с помощью HandleType SQL_HANDLE_STMT и handle of StatementHandle. В следующей таблице перечислены значения SQLSTATE, которые обычно возвращаются SQLParamData и объясняются каждый из них в контексте этой функции. Нотация "(DM)" предшествует описаниям SQLSTATEs, возвращаемым диспетчером драйверов. Возвращаемый код, связанный с каждым значением SQLSTATE, SQL_ERROR, если не указано иное.

Если SQLParamData вызывается при отправке данных для параметра в инструкции SQL, он может возвращать любой SQLSTATE, который может быть возвращен функцией, вызываемой для выполнения инструкции (SQLExecute или SQLExecDirect). Если он вызывается при отправке данных для столбца, обновляемого или добавляемого с помощью SQLBulkOperations или обновляемого с помощью SQLSetPos, он может возвращать любой SQLSTATE, который может быть возвращен SQLBulkOperations или SQLSetPos.

Комментарии

SQLParamData можно вызвать для предоставления данных во время выполнения данных для двух используемых: данных параметров, которые будут использоваться в вызове SQLExecute или SQLExecDirect, или данных столбцов, которые будут использоваться при обновлении строки или добавлении вызова SQLBulkOperations или обновления вызовом SQLSetPos. Во время выполнения SQLParamData возвращается в приложение индикатором того, какие данные требует драйвер.

Когда приложение вызывает SQLExecute, SQLExecDirect, SQLBulkOperations или SQLSetPos, драйвер возвращает SQL_NEED_DATA, если он нуждается в данных при выполнении. Затем приложение вызывает SQLParamData , чтобы определить, какие данные нужно отправлять. Если драйверу требуются данные параметров, драйвер возвращает в выходном буфере *ValuePtrPtr значение, которое приложение помещает в буфер набора строк. Приложение может использовать это значение для определения данных параметров, запрашивающих драйвер. Если драйверу требуются данные столбца, драйвер возвращает в буфере *ValuePtrPtr адрес, к которому изначально привязан столбец, как показано ниже.

Смещение привязки привязанных адресов + + ((номер строки — 1) x размер элемента)

где переменные определены, как указано в следующей таблице.

Он также возвращает SQL_NEED_DATA, который является индикатором для приложения, которое должно вызывать SQLPutData для отправки данных.

Приложение вызывает SQLPutData столько раз, сколько необходимо для отправки данных во время выполнения для столбца или параметра. После отправки всех данных для столбца или параметра приложение снова вызывает SQLParamData . Если SQLParamData снова возвращает SQL_NEED_DATA, данные должны отправляться для другого параметра или столбца. Поэтому приложение снова вызывает SQLPutData. Если все данные выполнения отправляются для всех параметров или столбцов, SQLParamData возвращает SQL_SUCCESS или SQL_SUCCESS_WITH_INFO, значение в *ValuePtrPtrPtr не определено, и можно выполнить инструкцию SQL Или вызов SQLBulkOperations или SQLSetPos .

Если SQLParamData предоставляет данные параметров для инструкции поиска или удаления, которая не влияет на строки в источнике данных, вызов SQLParamData возвращает SQL_NO_DATA.

Дополнительные сведения о передаче данных параметра во время выполнения инструкции см. в разделе "Передача значений параметров" в SQLBindParameter и отправке длинных данных. Дополнительные сведения о том, как данные столбца при выполнении обновляются или добавляются, см. в разделе "Использование SQLSetPos" в SQLSetPos, "Выполнение массовых обновлений с помощью закладок" в SQLBulkOperations, а также long Data и SQLSetPos и SQLBulkOperations.

SQLParamData можно вызвать для получения потоковых выходных параметров. Когда SQLMoreResults, SQLExecute, SQLGetData или SQLExecDirect возвращает SQL_PARAM_DATA_AVAILABLE, вызовите SQLParamData, чтобы определить, какой параметр имеет доступное значение. Дополнительные сведения о SQL_PARAM_DATA_AVAILABLE и потоковых выходных параметрах см. в разделе "Получение выходных параметров с помощью SQLGetData".

Пример кода

См. раздел SQLPutData.

Связанные функции

См. также

Справочник по API ODBC
Файлы заголовков ODBC
Получение выходных параметров с помощью метода SQLGetData