Manuals / Compaq / Computer Equipment / Computer Accessories

Compaq AAPVNFGTE manual May, Revision Update Information, Operating System, Software Version

Models: AAPVNFGTE

1 140

Download 140 pages 48.31 Kb

Page 1

Compaq TP Desktop Connector for ACMS

Client Services Reference Manual

Order Number: AA–PVNFG–TE

May 2002

This manual describes the services and commands needed to create and maintain TP Desktop Connector client programs that use the portable API.

Revision Update Information:	This is a revised manual.
Operating System:	Compaq OpenVMS VAX
	Compaq OpenVMS Alpha
Software Version:	Compaq TP Desktop Connector
	for ACMS Version 3.2

Compaq Computer Corporation Houston, Texas

Image 1

Compaq AAPVNFGTE manual May, Revision Update Information, Operating System, Software Version

Contents

May Revision Update InformationOperating System Software VersionPage Contents Forced Nonblocking Client Services Portable API Presentation ProceduresData Compression Monitor Commands System Management Service on OpenVMSCompaq Acms System Status Values Index Examples Exit Help List Renew Select SET ShowTables FiguresManual Structure Intended AudienceRelated Documents ChapterDescriptionCompaq Acms for OpenVMS Introduction User Input ConventionsPage Routine Names Services Description ParametersFormat ParametersParameter Data Types Type EntryData Type Description Called Routine Access Methods AccessAccess Method Description MechanismSession Environments Return StatusParameter-Passing Mechanisms Matrix of Services and Environments Callbacks Cont. Matrix of Services and EnvironmentsCont. Matrix of Services and Environments Page Summary of Portable API Client Services Summary of Portable API Client ServicesService Description Cont. Summary of Portable API Client Services Nonblocking Service UsageServiceDescription Parameter Memory AllocationCompletion Routine Format Nonblocking and Blocking RestrictionParameters Workspace Data Structures Callcontext Type void * Access read Mechanism by valueAcmsdiworkspace Structure and Initialization Macro Return StatusExample 2-1 Workspace Structure Deﬁnition and Initialization Example 2-2 Passing Workspaces to a ProcedureExample 2-3 Acmsdiworkspaceopt Type Deﬁnition Acmsdiworkspaceopt StructureExample 2-4 Passing Two Workspaces Acmsdiformrecordbind Structure Acmsdiworkspacebind StructureExample 2-4 Cont. Passing Two Workspaces Acmsdicalloption Union Structure Option Description OptionConstant Description Acmsdioption ArrayVoid *mymallocroutineint size long pwdexpbuffer Example 2-5 Initializing an Options ListInt status Example 2-6 Dynamically Specifying a TCP/IP Port IdentiﬁerFormat AcmsdicalltaskParameters SubmitteridTaskname Type char * Access read Mechanism by reference Workspaces Workspacecount Type long int Access read Mechanism by valueCallid Completionroutine Return StatusAcmsdicalltask Return Status Values Cont. acmsdicalltask Return Status Values Cancelreason Type long int Access read Mechanism by value AcmsdicancelCallcontext Type void* Access read Mechanism by value Reserved Type Access MechanismAcmsdicancel Return Status Values Acmsdicompletepp Ppstatus Type long int Access read Mechanism by valueAcmsdinoppactv Acmsdicompletepp Return Status ValuesAcmsdidispatchmessage Return Status Values AcmsdidispatchmessageStatusDescription Cont. acmsdidispatchmessage Return Status Values Acmsdireturnpointer Structure Type long int Access read Mechanism by referencePassword Type char * Access read Mechanism by reference Username Type char * Access read Mechanism by referenceAcmsdisignin Submitterid OptionsAcmsdisignin Return Status Values Format AcmsdisignoutAcmsdisignout Return Status Values Callcontext Type void * Access read Mechanism by valueAcmsdisignoutactv Cont. acmsdisignout Return Status ValuesPage Summary of Portable API Presentation Procedures Summary of Portable API Presentation ProceduresCustomer-Supplied Procedure Description Cont. Summary of Portable API Presentation Procedures Return Status Values Expected from Presentation ProceduresExample 3-1 Form Record Deﬁnition and Initialization Macro Acmsdiformrecord Structure and Macro CallBlocking and Nonblocking Usage Presentation Procedures in a Nonblocking EnvironmentFormssession AcmsdidisableSubmitterid AcmsdienableFormsprintﬁle Type char * Access read Mechanism by reference 8Portable API Presentation Procedures Acmsdireadmsg Prompttext Type char Access read Mechanism by reference10Portable API Presentation Procedures Receiverecordidentiﬁer Type char AcmsdireceiveReceivecontroltextcount Type long int TimeoutReceiverecord Return StatusAcmsdirequest Requestname Type char * Access read Mechanism by referenceWorkspaces Acmsdisend Sendrecordcount Type long int Access read Mechanism by valueReceivecontroltextcount Type long int Sendrecord Return StatusFormat Acmsditransceive20Portable API Presentation Procedures Timeout 22Portable API Presentation Procedures Format Acmsdiwritemsg24Portable API Presentation Procedures Version Type char * Access read Formﬁle Type char * Access readVersion-Checking Routines Acmsdicheckversion26Portable API Presentation Procedures Acmsdigetversion Version Type char * Access writePage Summary of Forced Nonblocking Procedures Summary of Forced Nonblocking ProceduresAcmsdiformrecordbind Structure Cont. Summary of Forced Nonblocking ProceduresExample 4-2 Workspace Structure Deﬁnition Example 4-1 Form Record DeﬁnitionFormat AcmsdicompletecallType Acmsdiworkspace or Acmsdiworkspaceopt array Acmsdicompletecall Return Status Values Return StatusFormat AcmsdibindenableargsCallid Formversion Type char * Access write Mechanism by referenceAcmsdiwrongbind Acmsdibindenableargs Return Status ValuesDirection AcmsdibindmsgText LengthStatus Description Acmsdibindmsg Return Status ValuesFormat AcmsdibindreceiveargsAcmsdibindreceiveargs Return Status Values TimeoutReceiverecord AcmsdibindreceiverecsAcmsdibindreceiverecs Return Status Values Acmsdibindrequestargs Requestname Type char * Access write Mechanism by referenceAcmsdibindrequestargs Return Status Values CallidDirection AcmsdibindrequestwkspsAcmsdibindrequestwksps Return Status Values Formssession AcmsdibindsendargsAcmsdibindsendargs Return Status Values TimeoutSendrecord Acmsdibindsendrecs10 acmsdibindsendrecs Return Status Values Formssession Acmsdibindsessionid11 acmsdibindsessionid Return Status Values Acmsdibindtransceiveargs 28Forced Nonblocking Client Services 12 acmsdibindtransceiveargs Return Status Values Return StatusAcmsdipoll Callcontext Type void * Access write Mechanism by referenceAcmsdiinternal Acmsdimixedmode Acmsdinomemory Acmsdiready 13 acmsdipoll Return Status ValuesAcmsdirecvexch Acmsdirequestexch13 Cont. acmsdipoll Return Status Values System Management Service on OpenVMS Usercontext ACMSDI$GETSUBMITTERINFOSubmitter Information Item Codes ItmlstACMSDI$KLATESTMSGTIME Code NameACMSDI$KDESKTOPID Cont. Submitter Information Item CodesACMSDI$KNODENAME ACMSDI$KSIGNINTIMEACMSDI$KTRANSPORT ACMSDI$KSUBMITTERIDACMSDI$KUSERNAME TargetsubmitterIDACMSDI$GETSUBMITTERINFO Return Status Values TargetusernameData Compression Monitor Commands Format ExitHelp Qualiﬁers ListAPPLICATION=application BEFORE=date-timeOUTPUT=ﬁle NODE=node-identiﬁerSINCE=date-time TASK=task-nameUSER=user-identiﬁer ExamplesSelects all records for task calls from node ALPHA1 19. /USER=MAIN-PLANT Renew ﬁle SelectNODE=node-identiﬁer 12Data Compression Monitor Commands Format SET14Data Compression Monitor Commands Show Page Table A-1 Acms System Status Values Symbol Value TextTable A-1 Cont. Acms System Status Values Compaq Acms System Status Values A-3 Page Index-1 IndexIndex-2 Index-3 Index-4