CDI_Abort_HACB

Requests the HAM to abort the specified HACB.

Thread Context:Non-Blocking

Syntax

    LONG CDI_Abort_HAC (
       LONG   reserved,
       LONG   hacbPutHandle,
       LONG   flag
       );

Parameters

reserved
(IN) The CDM should set this parameter to zero.
hacbPutHandle
(IN) Handle to the HACB request being aborted. The value of this parameter is obtained from the hacbPutHandle field of the original SuperHACB's member HACB.
flag
(IN) Flag indicating the type of abort the HAM is to perform. Its possible values are as follows:

Value

Description

0x00000000

Tells the HAM to unconditionally abort the HACB even if it has already been sent to the device.

0x00000001

Tells the HAM to conditionally abort the HACB if aborting only entails the unlinking of the HACB from the device queue. This is referred to as a clean abort.

0x00000002

Tells the HAM to check and see if the HACB can be cleanly aborted, but not to perform an abort.

Return Values

The following table lists return values and descriptions.

zero

Successful

nonzero

Unsuccessful

Remarks

This function is used by a CDM to abort a HACB sent to a HAM.