blk_getrow

Description

Server-side routine retrieves and stores a formatted bulk-copy row.

Syntax

CS_RETCODE blk_getrow(srvproc, blkdescp, rowp)
   SRV_PROC      *srvproc;
 CS_BLKDESC    *blkdescp;
 CS_BLK_ROW    *rowp;

Parameters

srvproc

A pointer to the SRV_PROC structure associated with the client sending the bulk-copy row. It contains all the information that Server-Library uses to manage communications and data between the Open Server and the client.

blkdescp

A pointer to a CS_BLKDESC structure containing information about bulk-copy data. This structure must have been previously allocated with a call to blk_alloc and initialized with a call to blk_init. This structure is used to interpret incoming formatted bulk-copy rows.

rowp

A pointer to a CS_BLK_ROW structure containing space for a formatted bulk-copy row. Space must have been previously allocated with blk_rowalloc.

The CS_BLK_ROW structure is a hidden structure that holds formatted bulk-copy rows sent from the client.

Returns

blk_getrow returns:

Returns

Indicates

CS_SUCCEED

The routine completed successfully.

CS_END_DATA

There are no more rows.

CS_BLK_HAS_TEXT

The row contains some text, image, sensitivity, or boundary data. Use blk_gettext to retrieve the text, image, sensitivity, or boundary data. Note that a return value of CS_BLK_HAS_TEXT implies a successful return, just like CS_SUCCEED.

CS_FAIL

The routine failed.

Usage

See also

blk_colval, blk_gettext, blk_rowalloc