Manuals / Compaq / Computer Equipment / Computer Accessories

Compaq AAPVNFGTE Workspacecount Type long int Access read Mechanism by value, Workspaces, Callid

Models: AAPVNFGTE

1 140

Download 140 pages 48.31 Kb

Page 33

acmsdi_call_task

workspace_count Type: long int Access: read Mechanism: by value

The decimal number of workspaces being passed to the task.

workspaces

Type: ACMSDI_WORKSPACE or ACMSDI_WORKSPACE_OPT array

Access: read/write

Mechanism: by reference

One or more optional workspaces to be passed to the task. You need to typecast your array to void *. The workspaces must be speciﬁed in the same order as they are declared in the task deﬁnition, and must match the number speciﬁed in the workspace_count parameter. If you use the ACMSDI_WORKSPACE_ OPT type, you must set the call_options parameter to allow unidirectional workspaces.

call_id

Type: ACMSDI_CALL_ID

Access: write

Mechanism: by reference

A structure deﬁned in the ACMSDI.H include ﬁle into which the acmsdi_call_ task service writes a newly created call identiﬁcation, a handle used by the TP Desktop Connector client services to identify an active call for a submitter.

completion_status Type: int Access: write Mechanism: by reference

The ﬁnal status of the TP Desktop Connector client service. In the blocking environment, the completion_status parameter is set to zero when the service starts successfully.

When the service completes, the completion_status parameter contains the ﬁnal status. See Table 2–2 for the list of return status values.

When a task is canceled, the TP Desktop Connector gateway reports a speciﬁc error, where possible. If the gateway cannot convert a ACMS error to a speciﬁc TP Desktop Connector status, it returns ACMSDI_TASK_FAILED to the desktop client program.

TP Desktop Connector Portable API Client Services 2–15

Image 33

Compaq AAPVNFGTE manual Workspacecount Type long int Access read Mechanism by value, Workspaces, Callid

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 ParametersType Entry Parameter Data TypesData Type Description Called Routine Access Methods AccessAccess Method Description MechanismReturn Status Session EnvironmentsParameter-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 AllocationNonblocking and Blocking Restriction Completion Routine FormatParameters 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 ProcedureAcmsdiworkspaceopt Structure Example 2-3 Acmsdiworkspaceopt Type DeﬁnitionExample 2-4 Passing Two Workspaces Acmsdiworkspacebind Structure Acmsdiformrecordbind 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 Workspacecount Type long int Access read Mechanism by value WorkspacesCallid Return Status CompletionroutineAcmsdicalltask 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 Acmsdidispatchmessage Return Status ValuesStatusDescription Cont. acmsdidispatchmessage Return Status Values Acmsdireturnpointer Structure Type long int Access read Mechanism by referenceUsername Type char * Access read Mechanism by reference Password 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