Important: The information in this document is obsolete and should not be used for new development.
ASPCloseAll
TheASPCloseAll
function closes all of the active ASP sessions on the node.
FUNCTION ASPCloseAll (thePBptr: XPPParmBlkPtr; async: Boolean): OSErr;
thePBptr
- A pointer to an XPP parameter block.
async
- A Boolean that specifies whether the function should be executed asynchronously or synchronously. Specify
TRUE
for asynchronous execution.
--> ioCompletion ProcPtr A pointer to a completion routine. <-- ioResult OSErr The function result. --> ioRefNum Integer The .XPP driver reference number. --> csCode Integer Always closeAll for this function. DESCRIPTION
To close all of the ASP sessions that are active and maintained by the .XPP driver on
the node, you call theASPCloseAll
function. This function cancels all active requests, and it invokes the attention routines for any active sessions, if attention routines were provided. A good use of this function is as a system-level function call to ensure that all ASP sessions are closed before you close the .XPP driver.SPECIAL CONSIDERATIONS
Note that you must provide the .XPP driver reference number as an input parameter
to this function. You can obtain the driver reference number by calling the Device Manager'sOpenDriver
function.ASSEMBLY-LANGUAGE INFORMATION
To execute theASPCloseAll
function from assembly language, call the_Control
trap macro with a value ofcloseAll
in thecsCode
field of the parameter block. You must also specify the .XPP driver reference number. To execute the_Control
trap asynchro-
nously, include the value,ASYNC
in the operand field.RESULT CODES
aspParamErr -1070 You specified an invalid session reference number,
or the session has been closedaspSessClosed -1072 The .XPP driver is in the process of closing
down the session