Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 2.53 KB

bcp-colptr.md

File metadata and controls

58 lines (42 loc) · 2.53 KB
title description author ms.author ms.date ms.service ms.subservice ms.topic helpviewer_keywords apilocation apiname apitype
bcp_colptr
bcp_colptr
markingmyname
maghan
03/14/2017
sql
native-client
reference
bcp_colptr function
sqlncli11.dll
bcp_colptr
DLLExport

bcp_colptr

[!INCLUDESQL Server Azure SQL Database Synapse Analytics PDW]

Sets the program variable data address for the current copy into [!INCLUDEssNoVersion].

Syntax

  
RETCODE bcp_colptr (  
        HDBC hdbc,  
        LPCBYTE pData,  
        INT idxServerCol);

Arguments

hdbc
Is the bulk copy-enabled ODBC connection handle.

pData
Is a pointer to the data to copy. If the bound data type is large value type (such as SQLTEXT or SQLIMAGE), pData can be NULL. A NULL pData indicates long data values will be sent to SQL Server in chunks using bcp_moretext.

If pData is set to NULL and the column corresponding to the bound field is not a large value type, bcp_colptr fails.

For more information on large value types, see bcp_bind.

idxServerCol
Is the ordinal position of the column in the database table to which the data is copied. The first column in a table is column 1. The ordinal position of a column is reported by SQLColumns.

Returns

SUCCEED or FAIL.

Remarks

The bcp_colptr function allows you to change the address of source data for a particular column when copying data to SQL Server with bcp_sendrow.

Initially, the pointer to user data is set by a call to bcp_bind. If the program variable data address changes between calls to bcp_sendrow, you can call bcp_colptr to reset the pointer to the data. The next call to bcp_sendrow sends the data addressed by the call to bcp_colptr.

There must be a separate bcp_colptr call for every column in the table whose data address you want to modify.

See Also

Bulk Copy Functions