Hex-Dump a Record/File
SimoHEX4 - The COBOL Source Code
  Table of Contents  v-16.01.01 - simohex4.htm 
  Introduction
  SimoHEX4, What it Does
  SimoHEX4, How to Use
  The COBOL Members
  The Program Source Code
  Pass Area Structure, a Copy File
  Summary
  Software Agreement and Disclaimer
  Downloads and Links
  Current Server or Internet Access
  Internet Access Required
  Glossary of Terms
  Comments or Feedback
  Company Overview
The SimoTime Home Page 

Table of Contents Previous Section Next Section Introduction

This routine will display the contents of a field in hexadecimal format with the EBCDIC and ASCII translation where possible. Also, the information may be written to a log file or simply passed back to the calling program. The format of the dump information is intended for use when dumping the contents of data file records.


We have made a significant effort to ensure the documents and software technologies are correct and accurate. We reserve the right to make changes without notice at any time. The function delivered in this version is based upon the enhancement requests from a specific group of users. The intent is to provide changes as the need arises and in a timeframe that is dependent upon the availability of resources.

Copyright © 1987-2019
SimoTime Technologies and Services
All Rights Reserved

Table of Contents Previous Section Next Section SimoHEX4, What it Does

The SimoHEX4 routine (or callable program) will convert a text string to its hexadecimal value with a display or logging capability. It will also translate the possible printable characters for both ASCII and EBCDIC.

The following is an example of the hexadecimal dump information provided by the sample programs. This information may be displayed to the screen or written to a log file.

*** 2004/11/18 20:59:58:41 Starting  - Data File Content Comparison by SimoTime Enterprises
*** 2004/11/18 20:59:58:43 1ST, 000000001(00001:00094)
*** 2004/11/18 20:59:58:44 ....:....1....:....2....:....3....:....4....:....5....:....6....:....7....:....8....:....9....
*** 2004/11/18 20:59:58:44 .......................@...@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@............@@@@@@@@@@@@...2....i.
*** 2004/11/18 20:59:58:45 FFFFFFFFFFFFC8AA988AA994C8944444444444444444444444444444444400000000C8884444444444440003900068
*** 2004/11/18 20:59:58:45 0000000000014923992436903170000000000000000000000000000000000000000051380000000000000002C0009C
*** 2004/11/18 20:59:58:46 000000000001Distributor Cap                                 ........Each            ..........
*** 2004/11/18 20:59:58:46 2ND, 000000001(00001:00094)                                     
*** 2004/11/18 20:59:58:46 ....:....1....:....2....:....3....:....4....:....5....:....6....:....7....:....8....:....9....
*** 2004/11/18 20:59:58:47 .......................@...@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@............@@@@@@@@@@@@...2....i.
*** 2004/11/18 20:59:58:48 FFFFFFFFFFFFC8AA988AA994C8944444444444444444444444444444444400020000C8884444444444440003900068
*** 2004/11/18 20:59:58:48 0000000000014923992436903170000000000000000000000000000000000003000A51380000000000000002C0009C
*** 2004/11/18 20:59:58:49 000000000001Distributor Cap                                 ........Each            ..........
*** 2004/11/18 20:59:58:49 ===============================================================#===#==========================
*** 2004/11/18 20:59:58:49 *

In the preceding example the RED lines show the possible ASCII-Text translation and the BLUE lines show the possible EBCDIC-Text translation. The GREEN lines are the hexadecimal dump information.

Table of Contents Previous Section Next Section SimoHEX4, How to Use

The coding to do the actual call to display and/or log the hex dump information is as follows.

      *****************************************************************
      *    The coding required to do the call to the Hex-Dump program.
      *    ------------------------------------------------------------
           CALL 'SIMOHEX4' USING SIMOHEX4-PASS-AREA

A copy file is provided to define the pass area to be used when calling SimoDUMP. The following statement is required in the WORKING STORAGE section of the calling program.

       WORKING STORAGE.
       . . .
       . . .
       COPY PASSHEX4.
       . . .

Table of Contents Previous Section Next Section The COBOL Members

The set of program members includes a program that creates the hexadecimal dump information and a copy file that defines the structure for a pass area.

Table of Contents Previous Section Next Section The Program Source Code

The following (SIMOHEX4.cbl) is a listing of the COBOL source member

       IDENTIFICATION DIVISION.
       PROGRAM-ID.    SIMOHEX4.
       AUTHOR.        SIMOTIME TECHNOLOGIES.
      *****************************************************************
      * Copyright (C) 1987-2019 SimoTime Technologies.                *
      *                                                               *
      * All rights reserved.  Unpublished, all rights reserved under  *
      * copyright law and international treaty.  Use of a copyright   *
      * notice is precautionary only and does not imply publication   *
      * or disclosure.                                                *
      *                                                               *
      * Permission to use, copy, modify and distribute this software  *
      * for any commercial purpose requires a fee to be paid to       *
      * SimoTime Technologies. Once the fee is received by SimoTime   *
      * the latest version of the software will be delivered and a    *
      * license will be granted for use within an enterprise,         *
      * provided the SimoTime copyright notice appear on all copies   *
      * of the software. The SimoTime name or Logo may not be used    *
      * in any advertising or publicity pertaining to the use of the  *
      * software without the written permission of SimoTime           *
      * Technologies.                                                 *
      *                                                               *
      * Permission to use, copy and modify this software for any      *
      * non-commercial purpose and without fee is hereby granted,     *
      * provided the SimoTime copyright notice appear on all copies   *
      * of the software. The SimoTime name or Logo may not be used in *
      * any advertising or publicity pertaining to the use of the     *
      * software without the written permission of SimoTime           *
      * Technologies.                                                 *
      *                                                               *
      * SimoTime Technologies makes no warranty or representations    *
      * about the suitability of the software for any purpose. It is  *
      * provided "AS IS" without any expressed or implied warranty,   *
      * including the implied warranties of merchantability, fitness  *
      * for a particular purpose and non-infringement. SimoTime       *
      * Technologies shall not be liable for any direct, indirect,    *
      * special or consequential damages resulting from the loss of   *
      * use, data or projects, whether in an action of contract or    *
      * tort, arising out of or in connection with the use or         *
      * performance of this software                                  *
      *                                                               *
      * SimoTime Technologies                                         *
      * 15 Carnoustie Drive                                           *
      * Novato, CA 94949-5849                                         *
      * 415.883.6565                                                  *
      *                                                               *
      * RESTRICTED RIGHTS LEGEND                                      *
      * Use, duplication, or disclosure by the Government is subject  *
      * to restrictions as set forth in subparagraph (c)(1)(ii) of    *
      * the Rights in Technical Data and Computer Software clause at  *
      * DFARS 52.227-7013 or subparagraphs (c)(1) and (2) of          *
      * Commercial  Computer Software - Restricted Rights  at 48      *
      * CFR 52.227-19, as applicable.  Contact SimoTime Technologies, *
      * 15 Carnoustie Drive, Novato, CA 94949-5849.                   *
      *                                                               *
      *****************************************************************
      *      This program is provided by SimoTime Technologies        *
      *        Our e-mail address is: helpdesk@simotime.com           *
      *     Also, visit our Web Site at http://www.simotime.com       *
      *                                                               *
      *****************************************************************
      *
      *****************************************************************
      * Source Member: SIMOHEX4.CBL
      * Copy Files:    HEXTABLE.CPY
      *                PASSHEX4.CPY
      *****************************************************************
      *
      * PASSHEX4 - Create Hexadecimal Dump information.
      *
      *
      * DESCRIPTION
      * -----------
      * This program will will scan the source buffer and create
      * HEX-Dump information plus ASCII and EBCDIC display info.
      *
      *           ************            ************
      *           * TXTHEXJ1 *            * TXTHEXE1 *
      *           ********jcl*            ********cmd*
      *                *                       *
      *                *                       *
      *           ************            ************
      *           * IEFBR14  *            * SIMOEXEC *
      *           ********utl*            ********cbl*
      *                *                       *
      *                *************************
      *                          *
      *                          *
      *    ************     ************     ************
      *    * TEXT0512 *-----* TXTHEXC1 *-----* QSAMHEXW *
      *    *******crlf*     ********cbl*     *******crlf*
      *                          *
      *                          *           ************
      *                          *------call-* SIMOHEX4 *
      *                          *           ********cbl*
      *                          *
      *                     ************
      *                     *   EOJ    *
      *                     ************
      *
      *****************************************************************
      *
      * MAINTENANCE
      * -----------
      * 1996/03/15 Simmons, Created program.
      * 1996/03/15 Simmons, No changes to date.
      *
      *****************************************************************
       DATA DIVISION.
       WORKING-STORAGE SECTION.
       01  FIVE-BYTES              pic X(5).

       01  IDX-1                   pic 9(3)    BINARY.
       01  IDX-1R                  REDEFINES IDX-1.
           05  IDX-1R-01           pic X.
           05  IDX-1R-02           pic X.
       01  IDX-2                   pic 9(3)    BINARY.

       COPY HEXTABLE.

      *****************************************************************
       LINKAGE SECTION.
       COPY PASSHEX4.

      *****************************************************************
       PROCEDURE DIVISION using PASSHEX4-PASS-AREA.

           add 8 to ZERO giving PASSHEX4-RESULT

           if  PASSHEX4-LENGTH not NUMERIC
               add 128 to ZERO giving PASSHEX4-LENGTH
           end-if

           if  PASSHEX4-LENGTH > 1024
               add 128 to ZERO giving PASSHEX4-LENGTH
           end-if

           if  PASSHEX4-REQUEST = 'DUMP'
               perform DUMP-PROCESSING
           else
               add 16 to ZERO giving PASSHEX4-RESULT
           end-if

           GOBACK.

      *****************************************************************
      * The following routines are in alphabetical sequence.          *
      *****************************************************************
       DUMP-PROCESSING.
           move all SPACES to PASSHEX4-DUMP-INFO
           perform varying IDX-2 from 1 by 1
               until IDX-2 > PASSHEX4-LENGTH
               add 1 to ZERO giving IDX-1
               move PASSHEX4-SOURCE(IDX-2:1) to IDX-1R-02
               add 1 to IDX-1
               move TAB-X1(IDX-1) to FIVE-BYTES
               move FIVE-BYTES(1:1) to PASSHEX4-UPPER(IDX-2:1)
               move FIVE-BYTES(2:1) to PASSHEX4-LOWER(IDX-2:1)
               move FIVE-BYTES(3:1) to PASSHEX4-EBCDIC(IDX-2:1)
               move FIVE-BYTES(4:1) to PASSHEX4-ASCII(IDX-2:1)
           end-perform
           exit.

      *****************************************************************
      *      This example is provided by SimoTime Technologies        *
      *        Our e-mail address is: helpdesk@simotime.com           *
      *     Also, visit our Web Site at http://www.simotime.com       *
      *****************************************************************

Table of Contents Previous Section Next Section Pass Area Structure, a Copy File

The following (PASSHEX4.cpy) is a listing of the COBOL copy file.

      *****************************************************************
      *     Data Structure or Pass Area used for calling SIMOHEX4.    *
      *****************************************************************
      *         Copyright (C) 1987-2019 SimoTime Technologies         *
      *                     All Rights Reserved                       *
      *****************************************************************
      *              Provided by SimoTime Technologies                *
      *        Our e-mail address is: helpdesk@simotime.com           *
      *     Also, visit our Web Site at http://www.simotime.com       *
      *****************************************************************
      * PASSHEX4-REQUEST - This must contain the following value.     *
      *                    DUMP, Dump Buffer in Hexadecimal format.   *
      * PASSHEX4-RESULT  - Zero indicates a successful completion.    *
      *                    Non-Zero indicates a failure in processing *
      *                    the request.                               *
      * PASSHEX4-LENGTH  - Specifies the length of the text strings   *
      *                    for the PASSHEX4-SOURCE. If the length
      *                    exceeds 1024 then it will be reset to 128. *
      * PASSHEX4-SOURCE  - This is the input field for the SimoHEX4   *
      *                    routine. This field will not be modified.  *
      *                    The contents will be translated into a     *
      *                    haxadecimal format and the results of the  *
      *                    translation will be placed in the          *
      *                    following fields.                          *
      * PASSHEX4-ASCII   - This is a translation of possible ASCII.   *
      * PASSHEX4-UPPER   - This is leftmost (or high order) nibble.   *
      * PASSHEX4-LOWER   - This is rightmost (or low order) nibble.   *
      * PASSHEX4-EBCDIC  - This is a translation of possible EBCDIC.  *
      *****************************************************************
       01  PASSHEX4-PASS-AREA.
      *    The following are provided by the calling program,
           05  PASSHEX4-REQUEST        PIC X(4).
      *    The PASSHEX4-RESULT may be modified by SimoHEX4...
           05  PASSHEX4-RESULT         PIC 9(4).
           05  PASSHEX4-LENGTH         PIC 9(5).
           05  PASSHEX4-SOURCE         PIC X(1024).
      *    The following are modified by SimoHEX4...
           05  PASSHEX4-DUMP-INFO.
               10  PASSHEX4-ASCII      PIC X(1024).
               10  PASSHEX4-UPPER      PIC X(1024).
               10  PASSHEX4-LOWER      PIC X(1024).
               10  PASSHEX4-EBCDIC     PIC X(1024).
      ***  PASSHEX4 - End-of-Copy File - - - - - - - - - - - PASSHEX4 *
      *****************************************************************
      *

Table of Contents Previous Section Next Section Summary

This routine will display the contents of a field in hexadecimal format with the EBCDIC and ASCII translation where possible. This document may be used to assist as a tutorial for new programmers or as a quick reference for experienced programmers.

In the world of programming there are many ways to solve a problem. This document and the links to other documents are intended to provide a greater awareness of the Data Management and Application Processing alternatives.

The documentation and software were developed and tested on systems that are configured for a SIMOTIME environment based on the hardware, operating systems, user requirements and security requirements. Therefore, adjustments may be needed to execute the jobs and programs when transferred to a system of a different architecture or configuration.

SIMOTIME Services has experience in moving or sharing data or application processing across a variety of systems. For additional information about SIMOTIME Services or Technologies please send an e-mail to: helpdesk@simotime.com or call 415 883-6565. We appreciate hearing from you.

Table of Contents Previous Section Next Section Software Agreement and Disclaimer

Permission to use, copy, modify and distribute this software, documentation or training material for any purpose requires a fee to be paid to SimoTime Technologies. Once the fee is received by SimoTime the latest version of the software, documentation or training material will be delivered and a license will be granted for use within an enterprise, provided the SimoTime copyright notice appear on all copies of the software. The SimoTime name or Logo may not be used in any advertising or publicity pertaining to the use of the software without the written permission of SimoTime Technologies.

SimoTime Technologies makes no warranty or representations about the suitability of the software, documentation or learning material for any purpose. It is provided "AS IS" without any expressed or implied warranty, including the implied warranties of merchantability, fitness for a particular purpose and non-infringement. SimoTime Technologies shall not be liable for any direct, indirect, special or consequential damages resulting from the loss of use, data or projects, whether in an action of contract or tort, arising out of or in connection with the use or performance of this software, documentation or training material.

Table of Contents Previous Section Next Section Downloads and Links

This section includes links to documents with additional information that are beyond the scope and purpose of this document. The first group of documents may be available from a local system or via an internet connection, the second group of documents will require an internet connection.

Note: A SimoTime License is required for the items to be made available on a local system or server.

Table of Contents Previous Section Next Section Current Server or Internet Access

The following links may be to the current server or to the Internet.

Note: The latest versions of the SimoTime Documents and Program Suites are available on the Internet and may be accessed using the Link to Internet icon. If a user has a SimoTime Enterprise License the Documents and Program Suites may be available on a local server and accessed using the Link to Server icon.

Link to Internet   Link to Server   Explore a complete list of the SimoTime Callable Routines or Utility Programs. This includes the callable routines and utility programs for the Micro Focus environment.

Link to Internet   Link to Server   Explore The ASCII and EBCDIC Translation Tables. These tables are provided for individuals that need to better understand the bit structures and differences of the encoding formats.

Link to Internet   Link to Server   Explore The File Status Return Codes to interpret the results of accessing VSAM data sets and/or QSAM files.

Table of Contents Previous Section Next Section Internet Access Required

The following links will require an internet connect.

This suite of programs and documentation is available to download for review and evaluation purposes. Other uses will require a SimoTime Software License. Link to an Evaluation zPAK Option that includes the program members, documentation and control files.

A good place to start is The SimoTime Home Page for access to white papers, program examples and product information. This link requires an Internet Connection

Explore The Micro Focus Web Site for more information about products and services available from Micro Focus. This link requires an Internet Connection.

Table of Contents Previous Section Next Section Glossary of Terms

Link to Internet   Link to Server   Explore the Glossary of Terms for a list of terms and definitions used in this suite of documents and white papers.

Table of Contents Previous Section Next Section Comments or Feedback

This document was created and is copyrighted and maintained by SimoTime Technologies.

If you have any questions, suggestions, comments or feedback please call at 1 415 827-7045 or send an e-mail to: helpdesk@simotime.com

We appreciate hearing from you.

Table of Contents Previous Section Next Section Company Overview

SimoTime Technologies was founded in 1987 and is a privately owned company. We specialize in the creation and deployment of business applications using new or existing technologies and services. We have a team of individuals that understand the broad range of technologies being used in today's environments. Our customers include small businesses using Internet technologies to corporations using very large mainframe systems.

Quite often, to reach larger markets or provide a higher level of service to existing customers it requires the newer Internet technologies to work in a complementary manner with existing corporate mainframe systems. We specialize in preparing applications and the associated data that are currently residing on a single platform to be distributed across a variety of platforms.

Preparing the application programs will require the transfer of source members that will be compiled and deployed on the target platform.

The data will need to be transferred between the systems and may need to be converted and validated at various stages within the process.

SimoTime has the technology, services and experience to assist in the application and data management tasks involved with doing business in a multi-system environment.

Whether you want to use the Internet to expand into new market segments or as a delivery vehicle for existing business functions simply give us a call at 1 415 827-7045 or send an e-mail to: helpdesk@simotime.com

Also, check the web site at http://www.simotime.com


Return-to-Top
Hexadecimal Dump using COBOL
Copyright © 1987-2019
SimoTime Technologies and Services
All Rights Reserved
When technology complements business
http://www.simotime.com