BASS_StreamCancel

Cancels a pending internet stream request.

BOOL BASS_StreamCancel(
    void *user
);

Parameters

userThe user instance data of the request(s) to cancel, given when BASS_StreamCreateURL (or an add-on variant) was called. This cannot be NULL.

Return value

If successful, TRUE is returned, else FALSE is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLEuser does not match any pending requests.

Remarks

If there are multiple pending requests with the same user value then they will all be cancelled. This function signals the requests to cancel but does not wait for them to cancel, so they may still be pending when it returns.

Platform-specific

On Android, when using Java, user must refer to the same object as in the BASS_StreamCreateURL call. Different objects with the same values will not be recognised as the same.

See also

BASS_StreamCreateURL