summaryrefslogtreecommitdiffstats
path: root/WhisperNet/Internal/sCaptureCallbacks.cs
diff options
context:
space:
mode:
authorKonstantin <const@const.me>2023-01-18 19:55:25 +0100
committerKonstantin <const@const.me>2023-01-18 19:55:25 +0100
commitad097a744759c6a78e1b33ea9d2b4b2af01c529d (patch)
treeda738750a40790a2f2553b3ebce29b08027ea8df /WhisperNet/Internal/sCaptureCallbacks.cs
parent72b03a0d899e0de6a39be278b0efc31570cd7d59 (diff)
Consistent cancellation API across the library: S_OK = continue, S_FALSE = stop
Diffstat (limited to 'WhisperNet/Internal/sCaptureCallbacks.cs')
-rw-r--r--WhisperNet/Internal/sCaptureCallbacks.cs1
1 files changed, 1 insertions, 0 deletions
diff --git a/WhisperNet/Internal/sCaptureCallbacks.cs b/WhisperNet/Internal/sCaptureCallbacks.cs
index 483c2f2..0865a5a 100644
--- a/WhisperNet/Internal/sCaptureCallbacks.cs
+++ b/WhisperNet/Internal/sCaptureCallbacks.cs
@@ -3,6 +3,7 @@
namespace Whisper.Internal
{
/// <summary>Unmanaged code calls this to check for cancellation</summary>
+ /// <remarks>Return 0 to proceed, or 1 to stop the process and return from Context.runFull method</remarks>
[UnmanagedFunctionPointer( CallingConvention.StdCall )]
public delegate int pfnShouldCancel( IntPtr pv );