ASPAbortOS
The ASPAbortOS function cancels a specific pending request to open an ASP session function.
FUNCTION ASPAbortOS (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 abortOS for this function. |
| --> | abortSCBPointer | Ptr | A pointer to the session control block. |
Field Description
abortSCBPointer
- A pointer to the session control block (SCB) that you passed to the
ASPOpenSession function that you want to cancel.
DESCRIPTION
The ASPAbortOS function cancels a single call to the ASPOpenSession function if that function has not yet completed execution. You identify the request to be canceled by passing the ASPAbortOS function the pointer to the original session control block that you specified to open the session.
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's OpenDriver function.
ASSEMBLY-LANGUAGE INFORMATION
To execute the ASPAbortOS function from assembly language, call the _Control trap macro with a value of abortOS in the csCode 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
cbNotFound | -1102 | Specified SCB was not found (there is no outstanding open session function call with this SCB) |
SEE ALSO
For information on the session control block, see the description of the ASPOpenSession function on page 8-9.