__iew_fd_open() – Open a session

z/OS MVS Program Management: Advanced Facilities

__iew_fd_open() – Open a session

z/OS MVS Program Management: Advanced Facilities
SA23-1392-00

The __iew_fd_open() will create a context (_IEWFDContext) and initialize all the parameters in the context and load IEWBFDAT into memory. If successful, the context is created and returned to user for all subsequent API calls.

Note: In order to meet the PSW key requirement for the invocation environment, __iew_fd_open() may save the current PSW and the job step TCB keys. (See Environment and Setting the invocation environment).

This will be enabled by default if the program calling the Binder C/C++ API DLL functions is running under CICS®. It can be explicitly disabled by setting the environment variable IEWBNDD_JSTCBKEY to the value "NO", or explicitly enabled by setting IEWBNDD_JSTCBKEY to "YES", prior to calling __iew_fd_open().

If enabled for this and all other Binder C/C++ API function calls using the API context returned by this __iew_fd_open() call, the PSW key will be set to the job step TCB key and then reset back to the current PSW key, around every Binder regular API function call.

Format

#include <__iew_api.h>
_IEWFDContext *__iew_fd_open(_IEWTargetRelease __release,
                                          unsigned int *__return_code,
                                          unsigned int *__reason_code);

Parameters Descriptions

__release

Target release can be one of the following:

_IEW_ZOSV1R9
_IEW_ZOSV1R10
_IEW_ZOSV1R11
_IEW_ZOSV1R12
_IEW_ZOSV1R13
_IEW_ZOSV2R1

Note: It is recommended that you define the feature test macro _IEW_TARGET_RELEASE prior to the #include <__iew_api.h>, and that _IEW_TARGET_RELEASE be used for __release. This definition ensures that structure mappings in <__iew_api.h> are consistent with the data returned by the other API access functions.

__return_code

The return code.

__reason_code

The reason code.

Returned Value

If successful, __iew_fd_open() returns FD context.

If unsuccessful, __iew_fd_open() returns null.