Add Associated Space Entry (QbnAddAssociatedSpaceEntry) API


  Required Parameter Group:

1 Associated space identifier Input Char(10)
2 Associated space entry data Input Char(*)
3 Length of associated space entry data Input Binary(4)
4 Options Input Char(1)
5 Error code I/O Char(*)

  Default Public Authority: *USE

  Service Program: QBNPREPR

  Threadsafe: No

The Add Associated Space Entry (QbnAddAssociatedSpaceEntry) API may be used by a compiler preprocessor to put data in the associated space of the created module.


Authorities and Locks

None


Required Parameter Group

Associated space identifier
INPUT; CHAR(10)

The associated space identifier has the following special value:

*PREPROC Identifies the type of data being stored in the created module. The special value must be left-justified and padded with blanks.

Associated space entry data
INPUT; CHAR(*)

The data to be placed into the associated space of the created module. The format of this data is specified by the user. This data will be copied into an ILE bound program or ILE service program and is available for use when the program is running. The QbnRetrieveAssociatedSpace API is used to retrieve this data from an ILE program or service program.

Length of associated space entry data
INPUT; BINARY(4)

The length of the data contained in the associated space entry data parameter.

Options
INPUT; CHAR(1)

You must specify one of the following special values. If more than one associated space entry is defined as extendable during preprocessing, the module will not be created. If DB2 UDB for iSeries SQL statements are contained in the input source file, option 2 cannot be specified.

1 The associated space entry will not be extendable.
2 The associated space entry can be extended. The associated space expands as data is stored in the associated space using QbnAddAssociatedSpaceEntry API.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF5CA2 E &1 is not a valid associated space identifier parameter.
CPF5CA3 E Option &1 is not valid.
CPF5CA4 E Error occurred while addressing API Parameter.
CPF5D22 E Not able to locate internal data.
CPF5D24 E Unexpected error occurred during preprocessor processing.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R1
Top | Program and CL Command APIs | APIs by category