A Called COBOL Program
|
Hex-Dump of a Data String A Called COBOL Program |
|
| The SimoTime Home Page |
Introduction
The STPEEKC1 routine (or callable program) will access a user defined binary string of data and create a text string of data in a hex-decimal notation format that may be displayed or used in a review process that requires human observation.
This document provides a listing of the COBOL source code for the callable routine STPEEKC1. Additional information about this program may be obtained by sending an e-mail to: helpdesk@simotime.com
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-2023
SimoTime Technologies and Services
All Rights Reserved
STPEEKC1, What It Does
The STPEEKC1 routine (or callable program) will convert a user defined segment of memory to a text string of data in a hexadecimal notation format. The hexadecimal notation may be displayed or written to an ASCII/Text logging file.
The following is an example of the hexadecimal dump information provided for an ASCII encoded data string that contains "ABCDEFGHIJKLMNOPQRSTUVWXYZ".
Each single byte in the preceding string will produce two bytes of hexadecimal notation. The Hex Notation may be presented in 1 of 2 formats.
Format 1 will present a single line of Hex Notation.
Hex Notation: 4142434445464748494A4B4C4D4E4F505152535455565758595AFormat 2 will present two lines of Hex Notation. The first line shows the content of bits 0-3 for each byte of data. The second line shows the content of bits 4-7 for each byte of data.
1st Nibble is 44444444444444455555555555Note: Bits 0-3 may be referred to as the 1st nibble of a byte of data. Bits 4-7 may be referred to as the 2nd nibble of a byte of data.
STPEEKC1, How To Use
The coding to do the actual call to display and/or log the hexadecimal dump information is as follows.
*****************************************************************
* The coding required to do the call to the Hex-Dump program.
* ------------------------------------------------------------
CALL 'STPEEKC1' USING STPEEK-USR-DATA,
STPEEK-USR-SIZE,
STPEEK-HEX-DUMP,
STPEEK-HEX-TYPE
A copy file is provided to define the pass area to be used when calling STPEEKC1. The following statement is required in the WORKING STORAGE section of the calling program.
WORKING STORAGE.
. . .
. . .
COPY STPEEKB1.
. . .
You may view an example of a COBOL program that uses STPEEKC1 at http://www.simotime.com/tcpeek01.htm.
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.
The Program Source Code
The following (STPEEKC1.cbl) is the COBOL Source Code for the STPEEKC1 callable Hex-Dump routine.
IDENTIFICATION DIVISION.
PROGRAM-ID. STPEEKC1.
AUTHOR. SIMOTIME TECHNOLOGIES.
*****************************************************************
* Copyright (C) 1987-2023 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 *
* *
*****************************************************************
*
* PARAMETERS DESCRIPTION
* ------------------- -----------------------------------------
* STPEEK-USR-DATA Byte Buffer (may contain Binary values)
* STPEEK-USR-SIZE Fullword Integer (Computational)
* STPEEK-HEX-DUMP Character Buffer (Hex Notation)
* STPEEK-HEX-TYPE Format of Hex Notation Buffer
* 1 - Define one Line with two bytes
* 2 - Define two Line with one nibble each
*
* Return Code 0 Successful
* Return Code 4 Unexpected Condition
*
*****************************************************************
*
ENVIRONMENT DIVISION.
*****************************************************************
*
DATA DIVISION.
WORKING-STORAGE SECTION.
* ------------------------------------------------------------- *
01 HEX-TABLE pic X(16) value '0123456789ABCDEF'.
01 IX-1 pic 9(7) value 0.
01 IX-2 pic 9(7) value 0.
01 IX-3 pic 9(7) value 0.
01 IX-4 pic 9(7) value 0.
01 REG-1-X.
05 REG-1-9 pic 9(9) COMP value 0.
01 REG-2-X.
05 REG-2-9 pic 9(9) COMP value 0.
01 REG-3-X.
05 REG-3-9 pic 9(9) COMP value 0.
01 USER-RETURN-CODE pic 9(4) value 0.
*****************************************************************
LINKAGE SECTION.
COPY STPEEKB1.
*****************************************************************
PROCEDURE DIVISION using STPEEK-USR-DATA
STPEEK-USR-SIZE
STPEEK-HEX-DUMP
STPEEK-HEX-TYPE.
if STPEEK-USR-SIZE > 0
perform CONVERT-HEX-TO-TXT
add USER-RETURN-CODE to zero giving RETURN-CODE
else
add 4 to ZERO giving RETURN-CODE
end-if
GOBACK.
*****************************************************************
CONVERT-HEX-TO-TXT.
move ZERO to USER-RETURN-CODE
move SPACES to STPEEK-HEX-DUMP
add 1 to ZERO giving IX-1
add 1 to ZERO giving IX-2
add 2 to ZERO giving IX-3
add 61 to ZERO giving IX-4
perform until IX-1 > STPEEK-USR-SIZE
move STPEEK-USR-DATA(IX-1:1) to REG-1-X(4:1)
divide 16 into REG-1-9 giving REG-2-9 remainder REG-3-9
if STPEEK-HEX-TYPE = '1'
move HEX-TABLE(REG-2-9 + 1:1) to STPEEK-HEX-DUMP(IX-2:1)
move HEX-TABLE(REG-3-9 + 1:1) to STPEEK-HEX-DUMP(IX-3:1)
add 2 to IX-2
add 2 to IX-3
else
move HEX-TABLE(REG-2-9 + 1:1) to STPEEK-HEX-DUMP(IX-2:1)
move HEX-TABLE(REG-3-9 + 1:1) to STPEEK-HEX-DUMP(IX-4:1)
add 1 to IX-2
add 1 to IX-4
end-if
add 1 to IX-1
end-perform
exit.
Pass Area Structure, a Copy File
The following (STPEEKB1.cpy) is the COBOL copy file that may be used when calling STPEEKC1.
*****************************************************************
* STPEEKB1.cpy is a COBOL Copy Member *
* Data Structure or Pass Area used for calling STPEEKC1. *
* Copyright (C) 1987-2023 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 *
*****************************************************************
*
* PARAMETERS DESCRIPTION
* ------------------- -----------------------------------------
* STPEEK-USR-DATA Byte Buffer (may contain Binary values)
* STPEEK-USR-SIZE Fullword Integer (Computational)
* STPEEK-HEX-DUMP Character Buffer (Hex Notation)
* STPEEK-HEX-TYPE Format of Hex Notation Buffer
* 1 - Define one Line with two bytes
* 2 - Define two Line with one nibble each
* 1st line is 1st nibble (bits 0-3)
* 2nd line is 2nd nibble (bits 4-7)
*
01 STPEEK-USR-DATA PIC X(60).
01 STPEEK-USR-SIZE PIC 9(09) comp.
01 STPEEK-HEX-DUMP PIC X(120).
01 STPEEK-HEX-TYPE PIC X.
*** STPEEKB1 - End-of-Copy File - - - - - - - - - - - STPEEKB1 *
*****************************************************************
*
Summary
This document provides a listing of the COBOL source code for the callable routine STPEEKC1. 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 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 contact us using the information in the Contact, Comment or Feedback section of this document.
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.
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.
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 
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 
icon.
Explore the COBOL Connection for more examples of COBOL programming techniques and sample code.
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.
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.
Explore The File Status Return Codes to interpret the results of accessing VSAM data sets and/or QSAM files.
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 (including Micro Focus COBOL) and services available from Micro Focus. This link requires an Internet Connection.
Glossary of Terms
Explore the Glossary of Terms for a list of terms and definitions used in this suite of documents and white papers.
Comments or Feedback
This document was created and is maintained by SimoTime Technologies. If you have any questions, suggestions, comments or feedback please use the following contact information.
| 1. | Send an e-mail to our helpdesk. |
| 1.1. | helpdesk@simotime.com. |
| 2. | Our telephone numbers are as follows. |
| 2.1. | 1 415 763-9430 office-helpdesk |
| 2.2. | 1 415 827-7045 mobile |
We appreciate hearing from you.
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 or check the web site at http://www.simotime.com
| Return-to-Top |
| Hex Dump of a Data String |
| Copyright © 1987-2023 SimoTime Technologies and Services All Rights Reserved |
| When technology complements business |
| http://www.simotime.com |