COMPAQ COMPUTER CORPORATION SHALL NOT BE LIABLE FOR TECHNICAL OR EDITORIAL ERRORS OR OMISSIONS CONTAINED HEREIN, NOR FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES RESULTING FROM THE FURNISHINGS, PERFORMANCE, OR USE OF THIS MATERIAL. THIS INFORMATION IS PROVIDED "AS IS" AND COMPAQ COMPUTER CORPORATION DISCLAIMS ANY WARRANTIES, EXPRESS, IMPLIED, OR STATUTORY, AND EXPRESSLY DISCLAIMS THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR PARTICULAR PURPOSE, GOOD TITLE, AND AGAINST INFRINGEMENT.
The software described in this manual is furnished under a license agreement or nondisclosure agreement. The software may be used or copied only in accordance with the terms of the agreement.
Compaq and the Compaq logo are registered in the United States Patent and Trademark Office. Printed in U.S.A.
ACMS, DEC, DECdesign, DECforms, DECnet, DECnet-DOS, DECtp, DECwindows, OpenVMS, PATHWORKS, PATHWORKS for DOS, PATHWORKS for Macintosh, TP Desktop Connector, VAX, VAXcluster, VAXset, VMS, VT, and the DIGITAL logo are trademarks of Compaq Computer Corporation..)
The following are third-party trademarks:
Apple, AppleTalk, HyperCard, HyperTalk, Macintosh, and MacTCP are registered trademarks of Apple Computer, Inc.
DECnet/IPX Portal, InterConnections, Inc., Network Print Services, NPS, Terminal Emulation Services, and TES are trademarks of InterConnections, Inc.
4D, 4D External Kit, and 4th Dimension 4D are registered trademarks or trademarks of ACI and ACIUS, Inc.
Microsoft, Microsoft C, Microsoft COBOL, Microsoft Windows, Microsoft Windows 95, MS, MS-DOS, and Visual Basic are registered trademarks of Microsoft Corporation. Windows NT is a trademark of Microsoft Corporation.
Motif and OSF/Motif are registered trademarks of the Open Software Foundation, Inc.
NetWare and Novell are registered trademarks of Novell, Inc.
Open Desktop and SCO are trademarks of Santa Cruz Operations, Inc.
Open Look is a registered trademark of UNIX System Laboratories, Inc., a wholly owned subsidiary of Novell, Inc.
Oracle CDD and Oracle Rdb are registered trademarks of Oracle Corporation.
UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company, Ltd.
X Window System is a registered trademark of Massachusetts Institute of Technology.
All other trademarks and registered trademarks are the property of their respective holders.
This document is available on CDROM.
This document was prepared using VAX DOCUMENT, Version V3.2-1n.
|Chapter 1||Explains the format of the reference information.|
|Chapters 2, 3, 4, 5, and 6||Contain the reference information on Compaq TP Desktop Connector client services, presentation procedures, action routines, and the Compaq OpenVMS based system management service.|
|Chapter 7||Lists the serial communications commands.|
|Chapter 8||Lists the data compression monitor commands.|
|Appendix A||Lists the Compaq ACMS system status values that can be returned in the err2 parameter.|
|TP Desktop Connector||Refers to the Compaq TP Desktop Connector for ACMS software.|
|User Input||In examples, user input is highlighted with bold type.|
|$||The dollar sign indicates a generic command line prompt. This prompt may be different on your system.|
|[Return]||A key name in a box indicates that you press that key on the keyboard.|
|[Ctrl/x]||Press the Ctrl (control) key and hold it down while pressing the specified key (indicated here by x).|
|WORD||Uppercase text indicates OpenVMS data types, commands, keywords, logical names, and routines or services; C files and data structures; Microsoft Windows data structures; or HyperCard data types.|
|word||In format descriptions, lowercase words indicate parameters, variables, services, or procedures.|
|italics||Italics are used for emphasis and for parameters in text. Titles of manuals are also italicized.|
|||In format descriptions, square brackets surround a choice of options; select none, one, several, or all of the choices.|
A vertical ellipsis in an example means that information not directly related to the example has been omitted.
Square brackets () indicate optional parameters in the call.
|Type||Data type of the parameter|
|Access||Method by which the called routine accesses the parameter|
|Mechanism||Method by which a parameter is passed to the called routine|
|ACMSDI_CALL_ID||Identification returned by the acmsdi_call_task service|
|ACMSDI_FORM_RECORD||Structure defined in the ACMSDI.H include file (see Section 3.1.2)|
|ACMSDI_FORM_RECORD_BIND||Structure defined in the ACMSDI.H and ACMSDI.BAS include files (see Section 4.1.1)|
|ACMSDI_FORMS_SESSION_ID||Structure defined in the ACMSDI.H include file (see Section 3.5)|
|ACMSDI_OPTION||Union to specify sign-in options (see Section 2.11)|
|ACMSDI_CALL_OPTIONS||Union to specify call task options|
|ACMSDI_SUBMITTER_ID||Structure defined in the ACMSDI.H include file (see Section 2.11)|
|ACMSDI_WORKSPACE||Array of structures defined in the ACMSDI.H include file to pass workspaces between the desktop system and the TP Desktop Connector gateway (see Section 2.4)|
|ACMSDI_WORKSPACE_BIND||Structure defined in the ACMSDI.H and ACMSDI.BAS include files (see Section 4.1.2)|
|ACMSDI_WORKSPACE_OPT||Array of structures defined in the ACMSDI.H include file to pass unidirectional workspaces between the desktop system and the TP Desktop Connector server|
|char *||Array of unsigned 8-bit integers|
|character string descriptor||Address of an OpenVMS string descriptor pointing to the character string to be passed|
|function address||Address of a function that complies with the prototype in ACMSDI.H for the completion routine|
|int||16-bit signed integer on DOS and SCO UNIX systems, 32-bit signed integer on OpenVMS and Compaq Tru64 UNIX systems|
|long||Synonym for long int|
|long int||32-bit signed integer|
|longword||32-bit unsigned integer|
|ptr||Longword pointer to data buffer|
|short||Synonym for short int|
|short int||16-bit signed integer|
|unsigned long int||32-bit unsigned integer|
|void *||Pointer to object of unknown type|
Access describes the way in which the called routine accesses the data specified by the parameter. The access methods are described in Table 1-3.
|Read||Data needed by the called routine to perform its operation is read but not returned.|
|Write||Data that the called routine returns to the calling routine is written into a location accessible to the calling routine.|
|Modify||Data is both read and returned by the called routine; input data specified by the parameter is overwritten.|
The parameter-passing mechanism is the way in which a parameter specifies the data to be used by the called routine. The passing mechanisms are described in Table 1-4.
|By value||The parameter contains a copy of the data to be used by the routine.|
|By reference||The parameter contains the address of the data to be used by the routine. The parameter is a pointer to the data. Because C supports only call by value, write parameters other than arrays and structures must be passed as pointers. References to names of arrays and structures are converted by the compiler to pointer expressions.|
|Windows 95||long int|
|Compaq Tru64 UNIX||long int|
|SCO UNIX||long int|
|Type of Services||Include File|
|Portable client services||ACMSDI$COMMON:ACMSDI.H|
|Client services for Macintosh software||ACMSDI_MAC.H|
In a forced nonblocking environment, service routines provide a method of polling that is used to determine the type of message sent from the back-end server. This message type may then be used to determine the appropriate action (for example, process the call completion or exchange step). The forced nonblocking software provides additional routines to access call completion and exchange step arguments. These session environments are explained in more depth in Chapter 2 and in Compaq TP Desktop Connector for ACMS Client Application Programming Guide.
Table 1-5 lists the services and indicates the session environments in which you can use each call.
|Service||Availability within Environment|
See description in Section 2.6
See description in Section 2.7
See description in Section 2.8
See description in Section 2.9
See description in Section 2.10
See description in Section 2.11
See description in Section 2.12
See description in Section 4.13
See description in Section 4.2
See description in Section 4.3
See description in Section 4.9
See description in Section 4.5
See description in Section 4.12
See description in Section 4.4
See description in Section 4.7
See description in Section 4.11
See description in Section 4.10
See description in Section 4.6
See description in Section 4.8
See description in Section 3.4
See description in Section 3.5
See description in Section 3.6
See description in Section 3.7
See description in Section 3.8
See description in Section 3.9
See description in Section 3.10
See description in Section 3.11
See description in Section 3.12.1
See description in Section 3.12.2