12 acmsdi_sign_out – Compaq TP DESKTOP CONNECTOR AAPVNFGTE User Manual

Page 47

Advertising
background image

acmsdi_sign_out

2.12 acmsdi_sign_out

TP Desktop Connector client programs call this service to terminate an active
session with a ACMS system. To insure that all network links are properly
shut down, the desktop client program calls the acmsdi_sign_out service before
terminating.

Format

acmsdi_sign_out (submitter_id,

[completion_status],
[completion_routine],

1

[call_context])

Parameters

submitter_id

Type: ACMSDI_SUBMITTER_ID
Access: read
Mechanism: by reference
The submitter identification returned by the acmsdi_sign_in service.

completion_status

Type: int
Access: write
Mechanism: by reference
The final status of the service. In the blocking environment, the completion_
status
parameter is set to zero when the service starts successfully.

When the service completes, completion_status contains the final status. See
Table 2–7 for a list of the return status values.

completion_routine

Type: function address

1

Access: read
Mechanism: by value
Address of a function to be called when the nonblocking service completes. The
completion routine is called by the acmsdi_dispatch_message service when the
reply is received from the TP Desktop Connector gateway.

1

For nonblocking only, see Section 2.3.

TP Desktop Connector Portable API Client Services 2–29

Advertising