Products Downloads


French version


 

 

This function is used to retrieve the section corresponding to the current item in the list defined by the section configured as a parameter; this is the last item handled by one of the list section item retrieval functions:

The functions:

  • PgExToolNewItemSection,

  • PgExToolReadValue,

  • PgExToolWriteValue,

do not affect the management of the current list item.

 

Important: The PgExTool dll must be loaded (using the LOAD_DLL instruction) at the beginning of the program and must still be loaded when section list management functions are called.

 

Parameters

ALPHA(256)

File

Full name of the data file.

ALPHA(n)

ListSection

List section.

ALPHA(n)

ItemSection

List item section (updated by the function) in the ListSection#number form; ItemSection should be specified to contain more than ListSection .

NUM_BIN_4

SectionSize

Size of ItemSection : n.

NUM_BIN_4

ReturnCode

Read return code (updated by the function).

 

Possible return code values

0

Read operation successful: ItemSection is configured, and contains a section that can be used in the functions PgExToolReadValue and PgExToolWriteValue.

 

Failure while retrieving the list item: ItemSection is cleared.

-1

Parameter file not found.

-2

Invalid ListSection :

-  either ListSection is empty,

-  or the data file is a parameter file for use with an EXIT program and ListSection is not one of the permitted sections.

-4

ItemSection is too small to contain the result of the function.

-10

The requested list item does not exist:

-  either no position in the list section has yet been set using the PgExToolFirstItemSection, PgExToolLastItemSection, PgExToolNextItemSection or PgExToolPreviousItemSection functions; consequently, the system cannot position to the current item.

-  or else the list is empty.

 

Example

/* This example handles a parameter file

/* for use in an EXIT program during a correction validation procedure

ALPHA(256)

   

PARAM

   

 

   

ALPHA(40)

   

ALPHA(50)

   

NUM_BIN_4

   

NUM_BIN_4

   

 

/* Beginning of program: loading PgExTool dll

LOAD_DLL 'PgExTool'

ListSection = 'RECEIVED_OBJECT'

SectionSize = 50

 

/* Manipulates the list section with the functions

/* PgExToolFirstItemSection, PgExToolLastItemSection,

/* PgExToolNextItemSection or PgExToolPreviousItemSection

 

/* reads the last item section manipulated in the list

CALL_DLL 'PgExTool' 'PgExToolItemSectionInUse' ParamFile ListSection ItemSection SectionSize ReturnCode

 

If ReturnCode = 0

/* ItemSection is configured and can be used

/* with the functions PgExToolReadValue and PgExToolWriteValue

END

/* End of program: unloading PgExTool dll

UNLOAD_DLL 'PgExTool'

 

 

 

Click below for further information about:

 

↑ Top of page

  • Aucune étiquette