From ad097a744759c6a78e1b33ea9d2b4b2af01c529d Mon Sep 17 00:00:00 2001
From: Konstantin <const@const.me>
Date: Wed, 18 Jan 2023 19:55:25 +0100
Subject: Consistent cancellation API across the library: S_OK = continue,
 S_FALSE = stop

---
 WhisperNet/Internal/sCaptureCallbacks.cs | 1 +
 1 file changed, 1 insertion(+)

(limited to 'WhisperNet/Internal/sCaptureCallbacks.cs')

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 );
 
-- 
cgit v1.2.3