CancelKernelEventArgs Class

Definition

Namespace:: Microsoft.SemanticKernel

Assembly:: Microsoft.SemanticKernel.Abstractions.dll

Package:: Microsoft.SemanticKernel.Abstractions v1.45.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Events are deprecated in favor of filters. Example in dotnet/samples/GettingStarted/Step7_Observability.cs of Semantic Kernel repository.

Provides an EventArgs for cancelable operations related to Kernel-based operations.

[System.Obsolete("Events are deprecated in favor of filters. Example in dotnet/samples/GettingStarted/Step7_Observability.cs of Semantic Kernel repository.")]
public abstract class CancelKernelEventArgs : Microsoft.SemanticKernel.KernelEventArgs

[<System.Obsolete("Events are deprecated in favor of filters. Example in dotnet/samples/GettingStarted/Step7_Observability.cs of Semantic Kernel repository.")>]
type CancelKernelEventArgs = class
    inherit KernelEventArgs

Public MustInherit Class CancelKernelEventArgs
Inherits KernelEventArgs

Inheritance: EventArgs

KernelEventArgs
CancelKernelEventArgs

Derived: Microsoft.SemanticKernel.FunctionInvokedEventArgs

Microsoft.SemanticKernel.FunctionInvokingEventArgs

Microsoft.SemanticKernel.PromptRenderedEventArgs

Attributes: ObsoleteAttribute

Properties

Name	Description
Arguments	Gets the arguments associated with the operation. (Inherited from KernelEventArgs)
Cancel	Gets or sets a value indicating whether the operation associated with the event should be canceled.
Function	Gets the KernelFunction with which this event is associated. (Inherited from KernelEventArgs)
Metadata	Gets a dictionary of metadata related to the event. (Inherited from KernelEventArgs)

Applies to