CBL_GET_PROGRAM_INFO

On Entry:

function

Specifies the function to be performed:

0	Note: This function is supported for COBOL programs only. Return status information for the current program. If you want to retrieve further information on this program, then bit 0 of the cblte-gpi-flags parameter must be set to indicate that this function should return cblte-gpi-handle, which will be used as an input to function 2 through 8. The initial program associated with cblte-gpi-handle is the current program. When other functions that use cblte-gpi-handle have completed, you must use CBL_GET_PROGRAM_INFO again, with function set to 3, to deallocate the handle.
1	Return status information for named program. If you want to retrieve further information on this program, then bit 0 of the cblte-gpi-flags parameter must be set to indicate that this function should return cblte-gpi-handle, which will be used as an input to function 2 through 8. The initial program associated with cblte-gpi-handle is the named program. When other functions that use cblte-gpi-handle have completed, you must use CBL_GET_PROGRAM_INFO again, with function set to 3, to deallocate the handle.
2	Note: This function is supported for COBOL programs only. Return status information for the program that called the program currently associated with cblte-gpi-handle. This function requires that cblte-gpi-handle has been set up using functions 0 or 1. The program associated with cblte-gpi-handle is updated to the calling program. When other functions that use cblte-gpi-handle have completed, you must use CBL_GET_PROGRAM_INFO again, with function set to 3, to deallocate the handle.
3	Close a previously created cblte-gpi-handle. This function requires a valid cblte-gpi-handle to have been created using function 0 or 1. A call with this function must be made when cblte-gpi-handle is finished with.
4	Find the first entry point of the program currently associated with cblte-gpi-handle. cblte-gpi-handle must have been set up using function 0 or 1. Once a call with this function has been made, you can repeatedly use this routine with function set to 5 to retrieve all remaining entry points in the program. Once all of the required entry points have been returned, you can use this routine with function set to 6 to terminate the entry-point search.
5	Find the next entry point of the program currently associated with cblte-gpi-handle. This function requires a valid cblte-gpi-handle to have been set up using function 0 or 1, and for function 4 to have been used to initiate the find first/next entry-point sequence.
6	Terminate the entry-point search. It requires a valid cblte-gpi-handle to have been set up using function 0 or 1, and for function 4 to have been called to initiate the find first/next entry-point sequence.
7	Return the full program-name of the program currently associated with cblte-gpi-handle. This function requires a valid cblte-gpi-handle to have been set up using function 0 or 1.
8	Note: This function is supported for native COBOL programs only. Return the number of arguments the program currently associated with cblte-gpi-handle was called with. This information can only be returned if the program is on the current call stack.
9	Reserved.
10	Return the path and program name, or the program name only for the program currently associated with cblte-gpi-handle. This function depends on whether bit 5 is set in cblte-gpi-flags.

cblte-gpi-size

The size of the parameter block including this field. This should be set to a value of 20 on 32-bit systems, or 28 on 64-bit systems.

cblte-gpi-flags

A 32-bit word indicating what information is to be returned:

Bit 0

Determines whether functions 0 and 1 return cblte-gpi-handle. For all other functions, this bit is ignored.

0	Do not return cblte-gpi-handle (if function is set to 0 or 1)
1	Return cblte-gpi-handle (if function is set to 0 or 1)

Bit 1

Determines whether functions 0 and 2 should return the program's basename in name-buf as part of the program status information.

0	Do not return basename of program (if function is set to 0 or 2)
1	Return basename of program in name-buf (if function is set to 0 or 2)

Bit 2

Determines whether basenames and full program names that are input or returned in name-buf should be in null-terminated or space- terminated format.

0	All input and output names are space-terminated
1	All input and output names are null-terminated.

Bit 3

Determines whether functions 0, 1 and 2 should return the program's attributes in cblte-gpi-attr.

0	Do not return program attributes in cblte-gpi-attr.
1	Return program attributes in cblte-gpi-attr.

Bit 4

Determines whether function 2 should return information for all programs.

0	Do not return program information.
1	Return program information.

Bit 5

Determines whether function 10 should return the full path to the loaded module associated with cblte-gpi-handle.

0	Return full path.
1	Return program name only.

Bits 6-31

Reserved for future use - must be set to 0.

cblte-gpi-handle

A handle created by function 0 or 1.

(Must be specified for functions 2-10.)

return-buf

If function is set to:

0	The basename of the program for which information is required.
8	A group predefined as 01 RETURN-BUF. 05 cblte-gpiai-size pic x(4) comp-5 value zeroes. 05 cblte-gpiai-argc pic x(4) comp-5 value zeroes. 05 cblte-gpiai-reserved1 pointer value null. 05 cblte-gpiai-reserved2 pointer value null. cblte-gpiai-size must be set to either 16 on 32-bit systems or 24 on 64-bit systems.

return-buf-len

The length of return-buf. If this is too small for the information being returned, the routine fails.