2. OpenAPI Function Reference : OpenAPI Functions : IIapi_getCopyMap() Function—Return the Data Format of Copy File and Database Table Involved in a Copy Statement
 
Share this page                  
IIapi_getCopyMap() Function—Return the Data Format of Copy File and Database Table Involved in a Copy Statement
The IIapi_getCopyMap() function returns a pointer to a copy map for data being copied from a file to a database table or from a database table to a file. The copy map describes the data in the file and in the database table.
IIapi_getCopyMap() output remains valid until the copy statement is closed with IIapi_close().
This function has the following syntax:
II_VOID IIapi_getCopyMap (IIAPI_GETCOPYMAPPARM *getCopyMapParm);
typedef struct _IIAPI_GETCOPYMAPPARM
{
      IIAPI_GENPARM    gm_genParm;
      II_PTR           gm_stmtHandle;
      IIAPI_COPYMAP    gm_copyMap;
} IIAPI_GETCOPYMAPPARM;
This function has the following parameters:
gm_genParm
Type: input and delayed output
Specifies the generic parameters. For a description, see Generic Parameters).
gm_stmtHandle
Type: input
Specifies the statement handle identifying the copy statement.
gm_copyMap
Type: delayed output
Specifies the copy map returned from the server. The copy map contains descriptions of the data in the file and in the database table.