IMS installed level API (DFSGVRM)

You can use the DFSGVRM API that is contained in the DFSGVRM macro in IMS to make a call from your applications to obtain the version, release, and modification level of an IMS system.

The DFSGVRM API can be called from within or outside of an IMS system with no specific authorization required for the call. When the call is made from within an IMS system, the IMS system must be in the running state. When the call is made from outside of an IMS system, the IMS system need not be in the running state.

The DFSGVRM macro supports the following functions:
FUNC=CALL
Gets the version, release, modification level of the IMS system and returns the information to an area in storage from where the calling application can retrieve the details.
FUNC=REL
Releases the storage used for the output that is requested by the calling application. The storage is released when it is no longer required. The calling application must use the REL function when the RETAREA register or the parameter list field GVRMP_A_OUTPUT_AREA is nonzero, regardless of the return code.

Accessing the DFSGVRM API

The DFSGVRM API is provided with IMS in the DFSGVRM assembler language macro.

Programming requirements

The DFSGVRM macro can be invoked from AMODE 24, 31, or 64 callers. The invoking module can reside anywhere below the 2 GB bar.
Note: RMODE(64) is not supported.

The program that invokes the DFSGVRM macro must be in task mode and not in cross-memory mode. The calling module need not reside in an APF-authorized library.

Execution environment

Programs that access the DFSGVRM API can execute in any IMS address space while the IMS system is in the running state.

Programs that access the DFSGVRM API can also execute in an address space outside of IMS, and the IMS system need not be in the running state. If called from outside of IMS, an IMS RESLIB must be available in the standard z/OS search order of load modules.

Register usage

Input register information:
  • Before invoking the DFSGVRM macro, GPR 13 must point to a standard 18-word save area.
Output register information:
R0
Reason code
R1
Used as a work register
R2 - R13
Unchanged
R14
Used as a work register
R15
Return code