IDMSIN01 Assembler Macro Syntax

Syntax
►►─── IDMSIN01 ─┬─ GETDATE date-parms ────┬──────────────────────────────────► ├─ GETMSG msg-parms ──────┤ ├─ GETPROF profile-parms ─┤ ├─ GETUSER user-parms ────┤ ├─ NOTRACE ───────────────┤ ├─ RRSCTX rrs-parms ──────┤ ├─ SETPROF profile-parms ─┤ ├─ STRCONV string-parms ──┤ ├─ SYSCTL sysctl-parms ───┤ ├─ TRACE ─────────────────┤ ├─ TXNSOFF ───────────────┤ ├─ TXNSON ────────────────┤ ├─ ENVINFO envinfo-parms ─┤ └─ FRMTDBK frmtdbk-parms ─┘ ►─┬────────────────────────────────────────┬────────────────────────────────► └─ ,PLIST= ─┬─ SYSPLIST ◄──────────────┬─┘ └─ parameter-list-pointer ─┘ ►─┬────────────────────────────────┬────────────────────────────────────────► └─ ,RPB= ─┬─ SQLRPB ◄──────────┬─┘ └─ rpb-area-pointer ─┘ ►─┬──────────────────────┬──────────────────────────────────────────────────►◄ └─ ,ERROR=error-label ─┘
 
Expansion of date-parms 
►─┬──────────────────┬─── ,DATEOUT=outdate ─────── ,FORMAT= ─┬─ DATEEXT ─────────► └─ ,DATEIN=indate ─┘ ├─ DATEINT ───────┤ ├─ DISPLAY ───────┤ ├─ EXTERNAL ──────┤ ├─ INTERNAL ──────┤ ├─ TIMEEXT ───────┤ ├─ TIMEINT ───────┤ └─ INTERNAL-UTC ──┘
Expansion of msg-parms
 
►─ ,SQLCA=sql-comm-area ─ ,SQLMSGB=sql-msg-block ───────────────────────────►
 
Expansion of profile-parms
►─ ,PVALUE=attribute-ptr ─ ,PRESULT=attribute-value ────────────────────────►
 
Expansion of user-parms
►─ ,USERID=user-id-addr ────────────────────────────────────────────────────►
 
Expansion of rrs-parms
►─ ,RRSCTXA=context-addr ─ ,RRSFUNA=function-addr ──────────────────────────►
 
Expansion of string-parms
►─ ,CONVFUN=convert-func ─ ,BUFFER=buffer-addr ─ ,BUFFERL=buffer-len-addr ──►
 
Expansion of sysctl-parms
►─ ,DDNAME=ddname-addr ─────────────────────────────────────────────────────►
 
Expansion of envinfo-parms
►─ ,EVBLOCK=
environment-return-area
────────────────────────────────────────►
 
Expansion of frmtdbk-parms
►─ ,DBKEY=
dbkey-addr
─ ,DBKFMT=
dbk-format-addr
─ ,DBKOUT=
dbk-output-addr
───►
 
IDMSIN01 indicates a request for the following IDMSIN01 functions, specified by the parameters, described below:
  • GETDATE
  • GETMSG
  • GETPROF
  • GETUSER
  • NOTRACE
  • RRSCTX
  • SETPROF
  • STRCONV
  • SYSCTL
  • TRACE
  • TXNSOFF
  • TXNSON
  • ENVINFO
  • FRMTDBK
Parameters
  • GETDATE
     Returns date and time in a display format.
    • ,DATEIN=
      indate
       Specifies the address of the 8-byte internal DATETIME stamp.
    • ,DATEOUT=
      outdate
       Specifies the 26-byte output field into which the display format of the DATETIME value is returned. This parameter is required for GETDATE processing.
    • ,FORMAT=
       Specifies the type of GETDATE function being requested.
    • DATEEXT
       Specifies that a 10-byte external DATE display is returned as an 8-byte DATE stamp.
    • DATEINT
       Specifies that an 8-byte internal DATE stamp is returned as a displayable 10-character DATE display.
    • DISPLAY
       Specifies that the current date and time are returned as a 26-character date-time display.
    • EXTERNAL
       Specifies that a 26-byte external DATETIME display is returned as an 8-byte DATETIME stamp.
    • INTERNAL
       Specifies that an 8-byte internal DATETIME stamp is returned as a  26-character date-time display.
    • TIMEEXT
       Specifies that an 8-byte external time display is returned as an 8-byte TIME stamp.
    • TIMEINT
       Specifies that an 8-byte internal TIME stamp is returned as a displayable 8-character TIME display.
    • INTERNAL-UTC
       Specifies that an 8-byte internal DATETIME stamp is returned as a 26-character date-time display converted to local time (from UTC).
  • GETMSG 
     Retrieves SQL error messages and places them in a user buffer that is displayed to the user.
    • ,SQLCA=
      sql-comm-area
       Specifies the address of the SQL communications area.
    • ,SQLMSGB=
      sql-msg-block
       Specifies the address of the SQL message control block.
  • GETPROF 
     Returns session profile information.
    • ,PVALUE=
      attribute-ptr
       Supplies the attribute keyword for the GETPROF function. 
      attribute-ptr
       must identify an 8-byte character field.
    • ,PRESULT=
      attribute-value
       Contains the attribute value for the GETPROF function. 
      attribute-value
       must identify a 32-byte character field.
  • GETUSER 
     Requests the current user-id established by the executed JCL information when running batch, or by the SIGNON USER 
    xxxxxxxx
     when running under CV.
    • ,USERID=
      user-id-addr
       Specifies the address of the 32-byte USERID returned value.
  • NOTRACE 
     Turns navigational DML or SQL DML tracing off. If the SYSIDMS parameter IDMSIN01_ONLY is specified, tracing is turned off for the CICS transaction that turned tracing on. 
  • RRSCTX 
     Extracts or sets a private RRS context (CV only).
    • ,RRSCTXA=
      context-addr
       Specifies the address of a 16-byte field for the RRS context token. Depending upon the function, this field is input, output, or both.
    • ,RRSFUNA=
      function-addr
       Specifies the address of a 1-byte field that contains the function to execute. The following are the valid function codes and their return codes:
    • X'01'
       Get RRS context. The following are the valid return codes:
      • 00 -- An RRS context exists; the field pointed to by RRSCTXA contains the current RRS context.
      • 04 -- No RRS context exists; the field pointed to by RRSCTXA is cleared.
      • 12 -- Invalid parameter list passed to IDMSIN01.
    • X'02'
       Set RRS context. If the field pointed to by RRSCTXA contains binary zeros, a new RRS context is created and returned; if the field is not binary zeros, it must contain an RRS context token which is saved by the CA IDMS transaction manager. No attempt is made to validate the RRS context token. The following are the valid return codes:
      • 00 -- The RRS context token was successfully saved by the CA IDMS transaction manager.
      • 08 -- An active RRS context already exists or there has been an internal error.
      • 12 -- Invalid parameter list passed to IDMSIN01.
      • Any other return codes -- An error has occurred. Return codes 103-107, 301, 701, 756, F00, and FFF are from context services. The descriptions can be found in the IBM section 
        MVS Programming Resource Recovery
         in the topic "Begin_Context."
    • X'03'
       End RRS context. The field pointed to by RRSCTXA must contain the token of the RRS context to be ended. The following are the valid return codes:
      • 00 -- The RRS context was successfully terminated. The field pointed to by RRSCTXA is set to binary zeroes.
      • 12 -- Invalid parameter list passed to IDMSIN01.
      • Any other return codes -- An error has occurred. Return codes 103-107, 301, 701, 756, F00, and FFF are from context services. The descriptions can be found in the IBM section 
        MVS Programming: Resource Recovery
         in the topic "End_Context."
  • SETPROF 
     Changes session profile information.
    • ,PVALUE=
      attribute-ptr
       Supplies the attribute keyword for the SETPROF function. 
      attribute-ptr
       must identify an 8-byte character field.
    • ,PRESULT=
      attribute-value
       Contains the attribute value for the SETPROF function. 
      attribute-value
       must identify a 32-byte character field.
  • STRCONV 
     Converts strings to and from EBCDIC and ASCII.
    • ,CONVFUN=
      convert-func
       Specifies the function to execute. To convert a string from ASCII to EBCDIC, specify 'ATOE'. To convert a string from EBCDIC to ASCII, specify 'ETOA'.
    • ,BUFFER=
      buffer-addr
       Specifies the name of the area that contains the string to convert.
    • ,BUFFERL=
      buffer-len-addr
       Specifies the name of a fullword field that contains the length in bytes of the string. Converts strings to and from EBCDIC and ASCII.
  • SYSCTL 
     Establishes the SYSCTL's DDname for running CV jobs in batch.
    • ,DDNAME=
      ddname-addr
       Specifies the address of the 8-byte SYSCTL that is passed.
  • TRACE 
     Turns navigational DML or SQL DML tracing on. If the SYSIDMS parameter IDMSIN01_ONLY is specified, tracing is turned on only for the CICS transaction that called IDMSIN01.
  • TXNSOFF 
     Turns transaction sharing OFF for the current task.
  • TXNSON 
     Turns transaction sharing ON for the current task.
  • ENVINFO 
     Returns runtime environment information.
    • ,EVBLOCK=
      returned-environment-information-area
       Specifies the address where the environment information is returned. The first halfword contains the maximum length of the data to be returned, followed by the return area.
  • FRMTDBK
     Formats the dbkey as character string 'page number:line index'. Leading zeros are removed from both numbers. If the dbkey has a value of zero, then the output field displays the character '0'. If the dbkey has a value of null, then the output field displays the character string '<NULL>'. If the database-key format is invalid, then the output field displays blanks and the return code is set to 8.
    • ,DBKEY=
      dbkey-addr
       Specifies the address of the dbkey to be formatted.
    • ,DBKFMT=
      dbk-format-addr
       Specifies the address of the halfword containing the database-key format associated with the dbkey. If the value provided is invalid (out of the range 2 through 12), then the output field displays blanks and the return code is set to 8.
    • ,DBKOUT=dbk-output-addr
       Specifies the address of the output field where the formatted character string will be stored. The field must have a length of 12 bytes.
  • PLIST= 
     Specifies the name of the parameter list to be used for the macro expansion. The parameter list must be at least 12 fullwords in length. This parameter can be used with all functions.
    • SYSPLIST
       Specifies the default parameter. If PLIST= is not specified, the default value of 
      parameter-list-pointer
       is SYSPLIST.
    • parameter-list-pointer
       Specifies the name of the parameter list to be used for the macro expansion.
  • RPB= 
     Specifies the name of the parameter list to be used for the macro RPB= is required for user-mode programs. If RPB= is not specified, the default value of 
    rpb-area-pointer
     is SQLRPB. This parameter can be used with all functions.
    • rpb-area-pointer
       Specifies the name of a 36-byte work area that is modified during function execution. The RPB work area must be fullword aligned.
  • ERROR=
    error-label
     Specifies a program label to which control should be passed in the event an error is detected during processing. This parameter can be used with all functions.