__iew_openW() – Open workmod

z/OS MVS Program Management: Advanced Facilities

__iew_openW() – Open workmod

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

The __iew_openW() creates a context(_IEWAPIContext) and initializes all of the parameters in the context and loads IEWBIND into memory. If successful, the context is created and returned to user for all subsequent API calls.

This is a ‘C’ function equivalent to binder API STARTD and CREATEW.

Note: In order to meet the PSW key requirement for the invocation environment, __iew_openW() 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_openW().

If enabled for this and all other Binder C/C++ API function calls using the API context returned by this __iew_openW() 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>
_IEWAPIContext *__iew_openW(_IEWTargetRelease __release,
                                          _IEWIntent __intent,
                                          _IEWList *__file_list,
                                          _IEWList *__exit_list, 
                                          const char *__parms,
                                          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.

__intent

processing intent can be one of the following:

_IEW_ACCESS
_IEW_BIND

Note: _IEW_ACCESS is more efficient but only allows the program to be inspected or copied. This can be changed later by __iew_resetW().

__file_list

file list is created by __iew_create_list().

__exit_list

exit list is created by __iew_create_list().

__parms

parameters – list of binder option.

__return_code

return code is passed back from STARTD or CREATEW.

__reason_code

reason code is passed back from STARTD or CREATEW

Returned Value

If successful, __iew_openW() returns API context.

If unsuccessful, __iew_openW() returns NULL.

Note: The returned value is the same as the code returned by a subsequent __iew_get_return_code().

Utilities Functions

__iew_create_list()