RNGIN (RPGLE)

Input Provider Interface
Details ....

Copybooks  

'reflection_h.rpgle'
'message_h.rpgle'
'input_provider_h.rpgle'
'input_provider_t.rpgle'

Procedures  

rng_input_check
Check input provider
rng_input_closeexported
Close action for input provider
rng_input_createexported
Create input provider
rng_input_finalizeexported
Dispose input provider
rng_input_openexported
Open action for input provider
rng_input_readexported
Read action for input provider

Detailed Description  

This input service module acts as part of the interface for input providers and forwards all input requests to the created input provider.
Author:
Mihael Schmidt
Date:
26.12.2010

Procedure Documentation  

rng_input_check  

voidrng_input_check(Pointer)
Checks if the input provider provides procedure pointers for all procedures it should implement.
Parameter:
Pointer   constInput provider

rng_input_close  

voidrng_input_close(Pointer)
Executes the close action for the passed input provider (f. e. closing a file).
Parameter:
Pointer   constPointer to input provider
Exported.

rng_input_create  

Pointerrng_input_create(Zeichen, Pointer, Zeichen)
Creates the input provider.
The passing of the userdata depends on the input provider implementation. Please look up the API documentation of the implementation.
Parameter:
Zeichen (10)   constService program (input provider)
Pointer   const   optionalUser data (optional)
Zeichen (256)   const   optionalCreate procedure name (optional)
Return value:
PointerPointer to input provider or *null if given service program does not exist
Exported.

rng_input_finalize  

voidrng_input_finalize(Pointer)
Calls clean up process and frees allocated memory.
Parameter:
PointerPointer to input provider
Exported.

rng_input_open  

voidrng_input_open(Pointer)
Executes the open action for the passed input provider (f. e. opening a file).
Parameter:
Pointer   constPointer to input provider
Exported.

rng_input_read  

voidrng_input_read(Pointer)
Executes the read action for the passed input provider (f. e. reading a file).
Parameter:
Pointer   constPointer to input provider
Exported.