OpenTP1 Version 7 Programming Reference C Language
This manual explains the syntax of dedicated library functions which can be used with the OpenTP1 application programs. The program products of OpenTP1 are as follows:
In this manual, an application program which is created by the user is abbreviated to a UAP (User Application Program).
Products described in this manual, other than those for which the manual is released, may not work with OpenTP1 Version 7 products. You need to confirm that the products you want to use work with OpenTP1 Version 7 products.
Intended readers
This manual is intended for programmers who create user application programs (UAPs) used with TP1/Server Base or TP1/LiNK.
Readers of this manual are assumed to have knowledge about operating systems, online systems, handling of the machine to be used, and the syntax of the C language (ANSI C, C++, or Classic C) used for coding application programs.
This manual assumes that the reader has read the OpenTP1 Programming Guide.
Organization of this manual
This manual is organized as follows:
Related publications
This manual is part of a related set of manuals. The manuals in the set, including this manual, are listed below. The manual numbers follow the manual titles.
OpenTP1 products
Other OpenTP1 products
Other related products
For OpenTP1 protocol manuals, please check whether English versions are available.
Conventions: Abbreviations for product names
This manual uses the following abbreviations for product names:
Abbreviation | Full name or meaning | ||
---|---|---|---|
AIX | AIX 5L V5.1 | ||
AIX 5L V5.2 | |||
AIX 5L V5.3 | |||
AIX V6.1 | |||
Client .NET | TP1/Client for .NET Framework | uCosminexus TP1/Client for .NET Framework | |
Connector .NET | TP1/Connector for .NET Framework | uCosminexus TP1/Connector for .NET Framework | |
DPM | JP1/ServerConductor/Deployment Manager | ||
HI-UX/WE2 | HI-UX/workstation Extended Version 2 | ||
HP-UX | HP-UX (IPF) | HP-UX 11i V2 (IPF) | |
HP-UX 11i V3 (IPF) | |||
HP-UX (PA-RISC) | HP-UX 11i V1 (PA-RISC) | ||
HP-UX 11i V2 (PA-RISC) | |||
IPF | Itanium(R) Processor Family | ||
Java | JavaTM | ||
JP1 | JP1/AJS2 | JP1/AJS2 - Agent | JP1/Automatic Job Management System 2 - Agent |
JP1/AJS2 - Manager | JP1/Automatic Job Management System 2 - Manager | ||
JP1/AJS2 - View | JP1/Automatic Job Management System 2 - View | ||
JP1/AJS2 - Scenario Operation | JP1/AJS2 - Scenario Operation Manager | JP1/Automatic Job Management System 2 - Scenario Operation Manager | |
JP1/AJS2 - Scenario Operation View | JP1/Automatic Job Management System 2 - Scenario Operation View | ||
JP1/NETM/Audit | JP1/NETM/Audit - Manager | ||
Linux | Linux(R) | ||
Linux (AMD64/Intel EM64T/x86) | Red Hat Enterprise Linux AS 4 (AMD64 & Intel EM64T) | ||
Red Hat Enterprise Linux AS 4 (x86) | |||
Red Hat Enterprise Linux ES 4 (AMD64 & Intel EM64T) | |||
Red Hat Enterprise Linux ES 4 (x86) | |||
Red Hat Enterprise Linux 5 (AMD/Intel 64) | |||
Red Hat Enterprise Linux 5 (x86) | |||
Red Hat Enterprise Linux 5 Advanced Platform (AMD/Intel 64) | |||
Red Hat Enterprise Linux 5 Advanced Platform (x86) | |||
Linux (IPF) | Red Hat Enterprise Linux AS 4 (IPF) | ||
Red Hat Enterprise Linux 5 (Intel Itanium) | |||
Red Hat Enterprise Linux 5 Advanced Platform (Intel Itanium) | |||
MS-DOS | Microsoft(R) MS-DOS(R) | ||
NETM/DM | JP1/NETM/DM Client | ||
JP1/NETM/DM Manager | |||
JP1/NETM/DM SubManager | |||
Oracle | Oracle 10g | ||
Oracle9i | |||
Solaris | Solaris 8 | ||
Solaris 9 | |||
Solaris 10 | |||
TP1/Client | TP1/Client/J | uCosminexus TP1/Client/J | |
TP1/Client/P | uCosminexus TP1/Client/P | ||
TP1/Client/W | uCosminexus TP1/Client/W | ||
uCosminexus TP1/Client/W(64) | |||
TP1/EE | uCosminexus TP1/Server Base Enterprise Option | ||
uCosminexus TP1/Server Base Enterprise Option(64) | |||
TP1/Extension 1 | uCosminexus TP1/Extension 1 | ||
uCosminexus TP1/Extension 1(64) | |||
TP1/FS/Direct Access | uCosminexus TP1/FS/Direct Access | ||
uCosminexus TP1/FS/Direct Access(64) | |||
TP1/FS/Table Access | uCosminexus TP1/FS/Table Access | ||
uCosminexus TP1/FS/Table Access(64) | |||
TP1/High Availability | uCosminexus TP1/High Availability | ||
uCosminexus TP1/High Availability(64) | |||
TP1/LiNK | uCosminexus TP1/LiNK | ||
TP1/Message Control | uCosminexus TP1/Message Control | ||
uCosminexus TP1/Message Control(64) | |||
TP1/Message Control/Tester | uCosminexus TP1/Message Control/Tester | ||
TP1/Message Queue | uCosminexus TP1/Message Queue | ||
uCosminexus TP1/Message Queue(64) | |||
TP1/Message Queue - Access | uCosminexus TP1/Message Queue - Access | ||
uCosminexus TP1/Message Queue - Access(64) | |||
TP1/Messaging | uCosminexus TP1/Messaging | ||
TP1/Multi | uCosminexus TP1/Multi | ||
TP1/NET/HDLC | uCosminexus TP1/NET/HDLC | ||
TP1/NET/High Availability | uCosminexus TP1/NET/High Availability | ||
uCosminexus TP1/NET/High Availability(64) | |||
TP1/NET/HSC | uCosminexus TP1/NET/HSC | ||
TP1/NET/Library | uCosminexus TP1/NET/Library | ||
uCosminexus TP1/NET/Library(64) | |||
TP1/NET/NCSB | uCosminexus TP1/NET/NCSB | ||
TP1/NET/OSAS-NIF | uCosminexus TP1/NET/OSAS-NIF | ||
TP1/NET/OSI-TP | uCosminexus TP1/NET/OSI-TP | ||
TP1/NET/SLU - TypeP2 | TP1/NET/Secondary Logical Unit - TypeP2 | uCosminexus TP1/NET/Secondary Logical Unit - TypeP2 | |
TP1/NET/TCP/IP | uCosminexus TP1/NET/TCP/IP | ||
uCosminexus TP1/NET/TCP/IP(64) | |||
TP1/NET/UDP | uCosminexus TP1/NET/User Datagram Protocol | ||
TP1/NET/User Agent | uCosminexus TP1/NET/User Agent | ||
TP1/NET/X25 | uCosminexus TP1/NET/X25 | ||
TP1/NET/X25-Extended | uCosminexus TP1/NET/X25-Extended | ||
TP1/NET/XMAP3 | uCosminexus TP1/NET/XMAP3 | ||
TP1/Offline Tester | uCosminexus TP1/Offline Tester | ||
TP1/Online Tester | uCosminexus TP1/Online Tester | ||
TP1/Resource Manager Monitor | uCosminexus TP1/Resource Manager Monitor | ||
TP1/Server Base | uCosminexus TP1/Server Base | ||
uCosminexus TP1/Server Base(64) | |||
TP1/Shared Table Access | uCosminexus TP1/Shared Table Access | ||
TP1/Web | uCosminexus TP1/Web | ||
Windows 2000 | Microsoft(R) Windows(R) 2000 Advanced Server Operating System | ||
Microsoft(R) Windows(R) 2000 Datacenter Server Operating System | |||
Microsoft(R) Windows(R) 2000 Professional Operating System | |||
Microsoft(R) Windows(R) 2000 Server Operating System | |||
Windows Server 2003 | Microsoft(R) Windows Server(R) 2003, Datacenter Edition | ||
Microsoft(R) Windows Server(R) 2003, Enterprise Edition | |||
Microsoft(R) Windows Server(R) 2003, Standard Edition | |||
Windows Server 2003 R2 | Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition | ||
Microsoft(R) Windows Server(R) 2003 R2, Standard Edition | |||
Windows Server 2003 x64 Editions | Microsoft(R) Windows Server(R) 2003, Datacenter x64 Edition | ||
Microsoft(R) Windows Server(R) 2003, Enterprise x64 Edition | |||
Microsoft(R) Windows Server(R) 2003, Standard x64 Edition | |||
Windows Server 2003 R2 x64 Editions | Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition | ||
Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition | |||
Windows Server 2008 | Microsoft(R) Windows Server(R) 2008 Datacenter (x86) | ||
Microsoft(R) Windows Server(R) 2008 Enterprise (x86) | |||
Microsoft(R) Windows Server(R) 2008 Standard (x86) | |||
Windows Server 2008 x64 Editions | Microsoft(R) Windows Server(R) 2008 Datacenter (x64) | ||
Microsoft(R) Windows Server(R) 2008 Enterprise (x64) | |||
Microsoft(R) Windows Server(R) 2008 Standard (x64) | |||
Windows Vista | Microsoft(R) Windows Vista(R) Business (x86) | ||
Microsoft(R) Windows Vista(R) Enterprise (x86) | |||
Microsoft(R) Windows Vista(R) Ultimate (x86) | |||
Windows Vista x64 Editions | Microsoft(R) Windows Vista(R) Business (x64) | ||
Microsoft(R) Windows Vista(R) Enterprise (x64) | |||
Microsoft(R) Windows Vista(R) Ultimate (x64) | |||
Windows XP | Microsoft(R) Windows(R) XP Professional Operating System |
This manual also uses the following acronyms:
Acronym | Full name or meaning |
---|---|
ACL | Access Control List |
ANSI | American National Standards Institute |
AP | Application Program |
API | Application Programming Interface |
C/S | Client/Server |
CRM | Communication Resource Manager |
CUP | Client User Program |
DAM | Direct Access Method |
DBMS | Database Management System |
DML | Data Manipulation Language |
DNS | Domain Name System |
FEP | Front End Processor |
GUI | Graphical User Interface |
HA | High Availability |
ISAM | Indexed Sequential Access Method |
IST | Internode Shared Table |
LAN | Local Area Network |
MCF | Message Control Facility |
MHP | Message Handling Program |
MQA | Message Queue Access |
MQI | Message Queue Interface |
OS | Operating System |
OSI | Open Systems Interconnection |
OSI TP | Open Systems Interconnection Transaction Processing |
PC | Personal Computer |
PRF | Performance |
RM | Resource Manager |
RPC | Remote Procedure Call |
SPP | Service Providing Program |
SUP | Service Using Program |
TAM | Table Access Method |
TCP/IP | Transmission Control Protocol/Internet Protocol |
UAP | User Application Program |
UOC | User Own Coding |
VM | Virtual Machine |
WAN | Wide Area Network |
WS | Workstation |
This manual uses the following conventions in diagrams:
Conventions: Differences between JIS and ASCII keyboards
The JIS code and ASCII code keyboards are different in the input characters represented by the following codes. In this manual, the use of a JIS keyboard is assumed for these characters.
Code | JIS keyboard | ASCII keyboard |
---|---|---|
(5c)16 | (yen symbol) | \ (backslash) |
(7e)16 | (overline) | ~ (tilde) |
Conventions: Fonts and symbols
The following table explains the fonts used in this manual:
Font | Convention |
---|---|
Bold | Bold type indicates text on a window, other than the window title. Such text includes menus, menu options, buttons, radio box options, or explanatory labels. For example:
|
Italics | Italics are used to indicate a placeholder for some actual text to be provided by the user or system. For example:
|
Code font | A code font indicates text that the user enters without change, or text (such as messages) output by the system. For example:
|
The following table explains the symbols used in this manual:
Symbol | Convention |
---|---|
| | In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example: A|B|C means A, or B, or C. |
{ } | In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. For example: {A|B|C} means only one of A, or B, or C. |
[ ] | In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example: [A] means that you can specify A or nothing. [B|C] means that you can specify B, or C, or nothing. |
... | In coding, an ellipsis (...) indicates that one or more lines of coding are not shown for purposes of brevity. In syntax explanations, an ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example: A, B, B, ... means that, after you specify A, B, you can specify B as many times as necessary. |
~ | The item before this symbol must be specified according to the rule given in < > after this symbol. |
< > | Information between these symbols is the syntax of the item. |
Conventions for permitted characters
In most cases, only the following characters are permitted as syntax elements (if other characters are permitted, the manual will state this explicitly):
Type | Definition |
---|---|
Upper-case alphabetic characters | A to Z |
Lower-case alphabetic characters | a to z |
Alphabetic characters | A to Z, a to z |
Numeric characters | 0 to 9 |
Alphanumeric characters | A to Z, a to z, 0 to 9 |
Symbols | !, #, $, %, &, ', (, ), *, +, -, ., /, :, ;, <, =, >, ?, @, [, \, ], ^, _, `, {, |, }, and ~ |
Path name | String that is composed of alphanumeric characters, slashes (/), and periods (.) and conforms to the rule under the OS used. |
Service group name | Must be an ASCII character string of up to 31 bytes. Note that null characters, spaces, at marks (@), and periods cannot be used. When a service group name is specified in a data area, it must end with a space. This space will not be included in the length of the character string. |
Service name | Must be an ASCII character string of up to 31 bytes. Note that null and space characters cannot be used. When a service name is specified in a data area, it must end with a space. This space will not be included in the length of the character string. |
Physical file name | Must be a path name consisting of the special file name followed by a name of 14 or less bytes. The entire path name must not exceed 63 characters. |
Logical file name | Must be an alphanumeric character string of 1 to 8 bytes that begins with an alphabetic character. |
Conventions: KB, MB, GB, and TB
This manual uses the following conventions:
Conventions: Platform-specific notational differences
For the Windows version of OpenTP1, there are some notational differences from the description in the manual. The following table describes these differences.
Item | Description in the manual | Change to: |
---|---|---|
Environment variable | $aaaaaa Example: $DCDIR |
%aaaaaa% Example: %DCDIR% |
Path name separator | Colon (:) | Semicolon (;) |
Directory name separator | Slash (/) | Backslash (\) |
Absolute path name | A path from the root directory Example: /tmp |
A path name from a drive letter and the root directory Example: C:\tmp |
Executable file name | File name only (without an extension) Example: mcfmngrd |
File name with an extension Example: mcfmngrd.exe |
make command | make | nmake |
The version numbers of Hitachi program products are usually written as two sets of two digits each, separated by a hyphen. For example:
The version number might be shown on the spine of a manual as Ver. 2.00, but the same version number would be written in the program as 02-00.
Acknowledgments
This manual contains information from the X/Open CAE Specification System Interfaces and Headers, Issue 4, (C202 ISBN 1-872630-47-2) Copyright (C) July 1992, X/Open Company Limited pursuant to approval from this company.
Part of that information is based on IEEE Std 1003.1-1990, (C) 1990 Institute of Electrical and Electronics Engineers, Inc. and IEEE Std 1003.2/D12, (C) 1992 Institute of Electrical and Electronics Engineers, Inc.
Any part of this manual that is copyrighted by the companies above may not be copied or reproduced in any form without prior approval gained from the copyright holders.
This manual contains information from the X/Open Preliminary Specification Distributed Transaction Processing: The TxRPC Specification, (P305 ISBN 1-85912-000-8) Copyright (C) July 1993, X/Open Company Limited, pursuant to approval from X/Open Company Limited.
Any part of this manual that is copyrighted by the above mentioned company may not be copied or reproduced in any form without prior approval gained from the copyright holder.
This manual contains information that is copyrighted by Open Software Foundation, Inc.
This document and the software described herein are furnished under a license, and may be used and copied only in accordance with the terms of such license and with the inclusion of the above copyright notice. Title to and ownership of the document and software remain with OSF or its licensors.
Quotations from X/Open CAE Specification Distributed Transaction Processing: The XATMI Specification published by X/Open Company Limited
The following section comes from Chapter 5. C Reference Manual Pages of the above document.
4.1 XATMI-Interfaced Application Programming Interface (tp~)
Quotations from X/Open CAE Specification Distributed Transaction Processing: The TX (Transaction Demarcation) Specification published by X/Open Company Limited
The following section comes from Chapter 5. C Reference Manual Pages of the above document.
4.2 TX-Interfaced Application Programming Interface (tx_~)
Quotations from X/Open Preliminary Specification Distributed Transaction Processing: The TxRPC Specification published by X/Open Company Limited
The following chapter comes from parts of Chapter 1. Introduction, Chapter 2 Model and Definitions, and Chapter 3. Interface Overview of the above document.
Important note on this manual
Please check the availability of the products and manuals for HAmonitor, ServerConductor/DeploymentManager, Cosminexus, and Job Management Partner 1/Automatic Job Management System 2.
All Rights Reserved. Copyright (C) 2006, 2010, Hitachi, Ltd.