TsgcWSAPIClient_MCP › Methods › SubscriptionsCancel

SubscriptionsCancel Method

Cancels a subscription opened with SubscriptionsListen.

Syntax

procedure SubscriptionsCancel(const aSubscriptionId: string);

Parameters

Name	Type	Description
aSubscriptionId	const string	Id returned by SubscriptionsListen.

Remarks

Requires the protocol version 2026-07-28; in the legacy era the method raises an exception. With HTTP the stream is closed; with stdio the client sends notifications/cancelled. OnMCPSubscriptionClosed is raised when the subscription ends. All subscriptions are cancelled automatically by Initialize and when the component is destroyed.

See Subscriptions.

Example

MCP.SubscriptionsCancel(vId);

Back to Methods