BASS.NET API for the Un4seen BASS Audio Library

BassBASS_StreamCancel Method

BASS.NET API for the Un4seen BASS Audio Library
Cancels a pending internet stream request.

Namespace:  Un4seen.Bass
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.18.0
Syntax
Copy
[DllImportAttribute("bass", CharSet = CharSet.Unicode)]
public static bool BASS_StreamCancel(
	IntPtr user
)

Parameters

user
Type: SystemIntPtr
The user instance data of the request(s) to cancel, given when BASS_StreamCreateURL(String, Int32, BASSFlag, DOWNLOADPROC, IntPtr) (or an add-on variant) was called. This cannot be NULL.

Return Value

Type: Boolean
If successful, is returned, else is returned. Use BASS_ErrorGetCode to get the error code.
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.

ERROR CODEDescription
BASS_ERROR_HANDLEuser does not match any pending requests.

See Also

Reference

Bass Class
Un4seen.Bass Namespace