SQL Reference Guide > SQL Reference Guide > SQL Statements > COPY FROM | INTO PROGRAM > COPY Arguments
Was this helpful?
COPY Arguments
The arguments passed by COPY must be declared in the user-defined handler with the types in the following tables. If II_SIZE_TYPE is required, the correct define can be found in II_SYSTEM/ingres/files/iiadd.h.
COPY INTO PROGRAM
Argument
Type
Description
byte_length
Pointer to long
(Input) Byte length of a row
row
Pointer to char
(Input) A row of data
bytes_written
Pointer to long
(Output) Number of bytes written
 
COPY FROM PROGRAM
Argument
Type
Description
byte_length
Pointer to long
(Input) For fixed-length formats, this argument indicates the expected byte count of the user-supplied row. For variable-length formats, this indicates the maximum length of a row.
row
Pointer to char
(Output) Pointer to the row buffer that the user-defined handler fills.
bytes_used
Pointer to long
Number of bytes of the row filled by the handler. If bytes_used is set to zero, COPY does not call the handler again. On fixed-length formats, Actian X raises an error if a non-zero bytes_used is not equal to byte_length. On variable-length formats, a non-zero bytes_used is ignored.
Last modified date: 08/14/2024