Edit

srv_setcoldata (Extended Stored Procedure API)

  • Article

Applies to: SQL Server

Important

This feature will be removed in a future version of SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Use CLR integration instead.

Specifies the current address for a column's data.

Syntax

  
int srv_setcoldata (  
SRV_PROC *  
srvproc  
,  
int   
column  
,  
void *  
data   
);

Arguments

srvproc
Is a pointer to the SRV_PROC structure that is the handle for a particular client connection. The structure contains information the Extended Stored Procedure API library uses to manage communication and data between the application and the client.

column
Indicates the number of the column the address is being specified for. Columns are numbered beginning with 1.

data
Is a pointer for a column's data. Memory allocated for data should not be freed until the column data is replaced by another call to srv_setcoldata, or until srv_senddone is called.

Returns

SUCCEED or FAIL.

Remarks

Each column of the row must be defined first with srv_describe. Column data addresses are initially set with srv_describe. If the address of the column data changes, srv_setcoldata must be called to specify the new address of the data and srv_setcoldata must be called separately for each changed column.

Null data is represented by setting the column's length to 0 with srv_setcollen. The data address is then ignored.

Important

You should thoroughly review the source code of extended stored procedures, and you should test the compiled DLLs before you install them on a production server. For information about security review and testing, see this Microsoft Web site.

See Also

srv_describe (Extended Stored Procedure API)