Anthropic Control

Properties   Methods   Events   Config Settings   Errors  

Provides direct access to the Anthropic Claude Messages API for sending and streaming messages, working with content blocks and tools, counting tokens, and listing models.

Syntax

Anthropic

Remarks

The Anthropic control provides a simple way to communicate with the Anthropic Messages API, the native API used by the Claude family of models.

The control models the Anthropic Messages API directly, including concepts such as the required token limit, top level system prompt, and content blocks.

Selecting an Endpoint

The ServerURL property specifies the base URL used to build every request. Operation paths, such as /messages, /models, and /messages/count_tokens, are appended to this value verbatim; no part of ServerURL is rewritten or normalized, and no /v1 segment is added or removed automatically.

By default, the control uses the official Anthropic endpoint, https://api.anthropic.com/v1. In most cases, the default endpoint is the correct choice. The ServerURL property should only be changed when connecting through a gateway or proxy that implements the Anthropic Messages API.

// Official Anthropic service. anthropic.ServerURL = "https://api.anthropic.com/v1"; anthropic.APIKey = "sk-ant-..."; // A local or corporate gateway that exposes the same Messages API. anthropic.ServerURL = "https://llm-gateway.example.com/anthropic/v1";

The APIKey property is sent as an x-api-key header. When it is left empty, no x-api-key header is sent at all, which supports gateways that inject credentials of their own. The AnthropicVersion property is sent as an anthropic-version header on every request, and is always present because the Messages API requires it.

Sending a Message

A conversation is built up in the Messages properties, which holds a list of anthropicmessage items. The AddMessage method appends a message with a Role of user or assistant and the specified text Content. To provide instructions that apply to the whole conversation, use the SystemPrompt property; the Messages API sends this separately as the top level system field rather than as a message.

The MaxTokens property is required by the Messages API and has no server side default. It must be set to a positive value before calling CreateMessage, which otherwise fails with error 802.

anthropic.APIKey = "sk-ant-..."; anthropic.Model = "claude-sonnet-5"; anthropic.MaxTokens = 1024; anthropic.SystemPrompt = "You are a concise assistant."; anthropic.AddMessage("user", "What is the capital of France?"); anthropic.CreateMessage(); // The assistant's reply is now the last item in Messages. string reply = anthropic.Messages[anthropic.Messages.Count - 1].Content; Console.WriteLine(reply);

Content Blocks

The Messages API carries the content of every message as an array of content blocks, each of which has a type such as text, image, tool_use, or tool_result. For the common case, the Content property of an anthropicmessage simply holds plain text, and the control wraps it in a single text block automatically.

When richer content is needed, set Content to a raw JSON array of content blocks. If the value begins with [ after leading whitespace is ignored, the control sends it verbatim as the message's content. This allows any block type supported by the API to be used without modeling each type separately.

The same rule applies in the opposite direction. When a reply consists of a single text block, the appended assistant message holds just that text. When a reply contains multiple blocks, or any block that is not text, the appended assistant message holds the raw content block array, so that sending the conversation back to the model reproduces the assistant turn. For a streamed reply, a block that is not text is rebuilt from the opening object the server sent for it and may therefore not be reproduced verbatim; a thinking block, for instance, is rebuilt without its signature.

Note that a reply which carries no content blocks at all produces an appended assistant message whose Content is empty. Such an entry should be removed, or filled in, before the conversation is sent again, because the API may reject a message with empty content.

// Supplying an image alongside text, using the raw content block form. anthropic.AddMessage("user", "[{\"type\":\"text\",\"text\":\"What is in this picture?\"}," + " {\"type\":\"image\",\"source\":{\"type\":\"base64\"," + " \"media_type\":\"image/jpeg\",\"data\":\"" + base64Image + "\"}}]"); anthropic.CreateMessage();

Streaming

Setting the Stream property to True before calling CreateMessage causes the request to be streamed. The ContentBlockDelta event then fires once for each incremental piece of the reply, reporting the zero based Index of the content block being built, the wire type of the delta in DeltaType, and the fragment itself in Delta.

A DeltaType of text_delta carries a fragment of visible text, while a DeltaType of input_json_delta carries a fragment of the JSON input of a tool the model is calling. Both are reported so that a caller can render text as it arrives and, if desired, observe tool input being assembled.

Once the stream completes, the fully assembled reply is appended to Messages and the ToolUse event fires for any completed tool block, exactly as in the non streaming case.

anthropic.Stream = true; anthropic.OnContentBlockDelta += (s, e) => { if (e.DeltaType == "text_delta") Console.Write(e.Delta); }; anthropic.AddMessage("user", "Write a short poem about the sea."); anthropic.CreateMessage();

Tool Calling

Tools give the model an opportunity to request that the calling application execute a function on its behalf. A tool is declared by first queuing its parameters with one or more calls to AddToolParam, then calling AddTool to consume the queued parameters and append a new anthropictool item to the Tools properties.

When the model decides to call a tool, its reply contains a tool_use content block and the ToolUse event fires once per block, providing the model assigned Id, the tool Name, and the InputJson object the model produced. To continue the conversation, append a message with role user whose Content is a raw content block array holding one tool_result block per call, then call CreateMessage again so the model can incorporate the result.

anthropic.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); anthropic.AddTool("get_weather", "Gets the current weather for a location."); anthropic.OnToolUse += (s, e) => { // Execute the requested tool and append its result as a 'tool_result' block. string result = GetWeather(e.InputJson); anthropic.AddMessage("user", "[{\"type\":\"tool_result\",\"tool_use_id\":\"" + e.Id + "\"," + " \"content\":\"" + result + "\"}]"); }; anthropic.AddMessage("user", "What is the weather like in Boston?"); anthropic.CreateMessage(); // If a tool was used, ToolUse fired and a 'tool_result' message was appended // above. Calling CreateMessage again lets the model produce a final answer. if (anthropic.Config("StopReason") == "tool_use") anthropic.CreateMessage();

Counting Tokens and Listing Models

The CountTokens method sends the current Messages properties, together with SystemPrompt and Tools, to {ServerURL}/messages/count_tokens and returns the number of input tokens the model would consume, without generating a reply. This is useful for checking a conversation against a context window before paying to send it.

int inputTokens = anthropic.CountTokens();

The ListModels method sends a request to {ServerURL}/models and fires the ModelList event once for each model reported by the server. Note that the Anthropic models endpoint returns a single page of results; the control reports the models on that first page and does not follow the cursor to subsequent pages.

anthropic.OnModelList += (s, e) => { Console.WriteLine(e.Id + " (" + e.DisplayName + ")"); }; anthropic.ListModels();

Embeddings

The Anthropic API does not provide an embeddings endpoint, so the control deliberately exposes no embedding method. Applications that need embeddings alongside Claude should use a provider that offers them, such as the OpenAI or Gemini control, or the LLMClient control with a provider other than spAnthropic.

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

AnthropicVersion Property (Anthropic Control)

The API version sent with every request.

Syntax

anthropiccontrol.AnthropicVersion[=string]

Default Value

"2023-06-01"

Remarks

This property specifies the value of the anthropic-version header, which the Anthropic API requires on every request. Unlike most properties, this header is always sent even when the property still holds its default value; it is exempt from the usual rule that only explicitly set properties are sent.

The default value is 2023-06-01, which is the current version of the API. Within a given version, existing input and output parameters are preserved, so this property normally does not need to be changed.

This property must not be set to an empty string before calling CreateMessage, CountTokens, or ListModels, which otherwise fail with error 802.

Refer to the Anthropic API documentation for the list of supported version values.

This property is not available at design time.

Data Type

String

APIKey Property (Anthropic Control)

The API key used to authenticate with the endpoint.

Syntax

anthropiccontrol.APIKey[=string]

Default Value

""

Remarks

This property specifies the API key used to authenticate requests. When set, it is sent as an x-api-key header.

When this property is left empty, no x-api-key header is sent at all. This supports gateways placed in front of the API that supply credentials of their own.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (Anthropic Control)

Whether to automatically detect and use firewall system settings, if available.

Syntax

anthropiccontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (Anthropic Control)

The type of firewall to connect through.

Syntax

anthropiccontrol.FirewallType[=integer]

Possible Values

fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (Anthropic Control)

The name or IP address of the firewall (optional).

Syntax

anthropiccontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (Anthropic Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

anthropiccontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (Anthropic Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

anthropiccontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

NOTE: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (Anthropic Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

anthropiccontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

MaxTokens Property (Anthropic Control)

The maximum number of tokens to generate before stopping.

Syntax

anthropiccontrol.MaxTokens[=integer]

Default Value

0

Remarks

This property specifies an upper bound on the number of tokens the model may generate in its reply. The model may stop before reaching this limit, and a reply that was cut short by it reports a StopReason of max_tokens.

This property is required by the Messages API, which defines no server side default for it. It must be set to a positive value before calling CreateMessage, which otherwise fails with error 802.

Different models accept different upper bounds for this value. Refer to the Anthropic API documentation for the limit that applies to the model named by Model.

This property is not available at design time.

Data Type

Integer

MessageCount Property (Anthropic Control)

The number of records in the Message arrays.

Syntax

anthropiccontrol.MessageCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageContent
• MessageRole

The array indices start at 0 and end at MessageCount - 1.

This property is not available at design time.

Data Type

Integer

MessageContent Property (Anthropic Control)

The content of the message.

Syntax

anthropiccontrol.MessageContent(MessageIndex)[=string]

Default Value

""

Remarks

The content of the message.

This property normally holds the plain text of the message, which is sent as a single text content block.

When richer content is needed, set this property to a raw JSON array of content blocks. If the value begins with [ after leading whitespace is ignored, it is sent verbatim. This allows blocks such as image, document, or tool_result to be supplied without separate properties for each block type.

The same distinction applies to a reply appended by CreateMessage. A reply consisting of one text block is stored as plain text, while a reply holding several blocks, or any block that is not text, is stored as the raw content block array.

The MessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageCount property.

This property is not available at design time.

Data Type

String

MessageRole Property (Anthropic Control)

The role of the message's author.

Syntax

anthropiccontrol.MessageRole(MessageIndex)[=string]

Default Value

""

Remarks

The role of the message's author.

This property identifies the role of the message's author. The Messages API accepts only user and assistant here; a system prompt is supplied through the SystemPrompt property instead.

The MessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageCount property.

This property is not available at design time.

Data Type

String

Model Property (Anthropic Control)

The model used when sending a message.

Syntax

anthropiccontrol.Model[=string]

Default Value

""

Remarks

This property specifies the identifier of the model that will process the request, for example claude-sonnet-5 or claude-opus-5. This property must be set before calling CreateMessage or CountTokens.

The ListModels method may be used to discover the model identifiers the endpoint accepts.

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (Anthropic Control)

The type of authorization to perform when connecting to the proxy.

Syntax

anthropiccontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), authDigest(1), authProprietary(2), authNone(3), authNtlm(4), authNegotiate(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (Anthropic Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

anthropiccontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

Data Type

Boolean

ProxyPassword Property (Anthropic Control)

A password if authentication is to be used for the proxy.

Syntax

anthropiccontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (Anthropic Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

anthropiccontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (Anthropic Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

anthropiccontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (Anthropic Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

anthropiccontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), psAlways(1), psNever(2), psTunnel(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (Anthropic Control)

A username if authentication is to be used for the proxy.

Syntax

anthropiccontrol.ProxyUser[=string]

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ServerURL Property (Anthropic Control)

The base URL of the Anthropic API endpoint.

Syntax

anthropiccontrol.ServerURL[=string]

Default Value

"https://api.anthropic.com/v1"

Remarks

This property specifies the base URL used to build request URLs. Operation paths such as /messages are appended to this value verbatim; no part of the value is rewritten, so endpoints that include or omit a version segment (such as /v1) are both supported.

By default, the control uses the official Anthropic endpoint, https://api.anthropic.com/v1. In most cases, the default endpoint is the correct choice. This property should only be changed when connecting through a gateway or proxy that implements the Anthropic Messages API.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (Anthropic Control)

The date on which this certificate becomes valid.

Syntax

anthropiccontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (Anthropic Control)

The date on which the certificate expires.

Syntax

anthropiccontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (Anthropic Control)

A comma-delimited list of extended key usage identifiers.

Syntax

anthropiccontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (Anthropic Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (Anthropic Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (Anthropic Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (Anthropic Control)

The issuer of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (Anthropic Control)

The private key of the certificate (if available).

Syntax

anthropiccontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (Anthropic Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (Anthropic Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

anthropiccontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (Anthropic Control)

The public key of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (Anthropic Control)

The textual description of the certificate's public key algorithm.

Syntax

anthropiccontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (Anthropic Control)

The length of the certificate's public key (in bits).

Syntax

anthropiccontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (Anthropic Control)

The serial number of the certificate encoded as a string.

Syntax

anthropiccontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (Anthropic Control)

The text description of the certificate's signature algorithm.

Syntax

anthropiccontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (Anthropic Control)

The name of the certificate store for the client certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (Anthropic Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

anthropiccontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (Anthropic Control)

The type of certificate store for this certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (Anthropic Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (Anthropic Control)

The MD5 hash of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (Anthropic Control)

The SHA-1 hash of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (Anthropic Control)

The SHA-256 hash of the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (Anthropic Control)

The text description of UsageFlags .

Syntax

anthropiccontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (Anthropic Control)

The flags that show intended use for the certificate.

Syntax

anthropiccontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (Anthropic Control)

The certificate's version number.

Syntax

anthropiccontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (Anthropic Control)

The subject of the certificate used for client authentication.

Syntax

anthropiccontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name properties and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common properties and their meanings are as follows:

If a property value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (Anthropic Control)

The certificate (PEM/Base64 encoded).

Syntax

anthropiccontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (Anthropic Control)

The date on which this certificate becomes valid.

Syntax

anthropiccontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (Anthropic Control)

The date on which the certificate expires.

Syntax

anthropiccontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (Anthropic Control)

A comma-delimited list of extended key usage identifiers.

Syntax

anthropiccontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (Anthropic Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (Anthropic Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (Anthropic Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (Anthropic Control)

The issuer of the certificate.

Syntax

anthropiccontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (Anthropic Control)

The private key of the certificate (if available).

Syntax

anthropiccontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (Anthropic Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

anthropiccontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (Anthropic Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

anthropiccontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (Anthropic Control)

The public key of the certificate.

Syntax

anthropiccontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (Anthropic Control)

The textual description of the certificate's public key algorithm.

Syntax

anthropiccontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (Anthropic Control)

The length of the certificate's public key (in bits).

Syntax

anthropiccontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (Anthropic Control)

The serial number of the certificate encoded as a string.

Syntax

anthropiccontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (Anthropic Control)

The text description of the certificate's signature algorithm.

Syntax

anthropiccontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (Anthropic Control)

The name of the certificate store for the client certificate.

Syntax

anthropiccontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (Anthropic Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

anthropiccontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (Anthropic Control)

The type of certificate store for this certificate.

Syntax

anthropiccontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (Anthropic Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

anthropiccontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (Anthropic Control)

The MD5 hash of the certificate.

Syntax

anthropiccontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (Anthropic Control)

The SHA-1 hash of the certificate.

Syntax

anthropiccontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (Anthropic Control)

The SHA-256 hash of the certificate.

Syntax

anthropiccontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (Anthropic Control)

The text description of UsageFlags .

Syntax

anthropiccontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (Anthropic Control)

The flags that show intended use for the certificate.

Syntax

anthropiccontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (Anthropic Control)

The certificate's version number.

Syntax

anthropiccontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (Anthropic Control)

The subject of the certificate used for client authentication.

Syntax

anthropiccontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name properties and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common properties and their meanings are as follows:

If a property value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (Anthropic Control)

The certificate (PEM/Base64 encoded).

Syntax

anthropiccontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (Anthropic Control)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

anthropiccontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), sslpPlatform(1), sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the control will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

Integer

SSLServerCertEffectiveDate Property (Anthropic Control)

The date on which this certificate becomes valid.

Syntax

anthropiccontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (Anthropic Control)

The date on which the certificate expires.

Syntax

anthropiccontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (Anthropic Control)

A comma-delimited list of extended key usage identifiers.

Syntax

anthropiccontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (Anthropic Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (Anthropic Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (Anthropic Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

anthropiccontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (Anthropic Control)

The issuer of the certificate.

Syntax

anthropiccontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (Anthropic Control)

The private key of the certificate (if available).

Syntax

anthropiccontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (Anthropic Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

anthropiccontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (Anthropic Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

anthropiccontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (Anthropic Control)

The public key of the certificate.

Syntax

anthropiccontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (Anthropic Control)

The textual description of the certificate's public key algorithm.

Syntax

anthropiccontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (Anthropic Control)

The length of the certificate's public key (in bits).

Syntax

anthropiccontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (Anthropic Control)

The serial number of the certificate encoded as a string.

Syntax

anthropiccontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (Anthropic Control)

The text description of the certificate's signature algorithm.

Syntax

anthropiccontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (Anthropic Control)

The name of the certificate store for the client certificate.

Syntax

anthropiccontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (Anthropic Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

anthropiccontrol.SSLServerCertStorePassword

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (Anthropic Control)

The type of certificate store for this certificate.

Syntax

anthropiccontrol.SSLServerCertStoreType

Possible Values

cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (Anthropic Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

anthropiccontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (Anthropic Control)

The MD5 hash of the certificate.

Syntax

anthropiccontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (Anthropic Control)

The SHA-1 hash of the certificate.

Syntax

anthropiccontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (Anthropic Control)

The SHA-256 hash of the certificate.

Syntax

anthropiccontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (Anthropic Control)

The text description of UsageFlags .

Syntax

anthropiccontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (Anthropic Control)

The flags that show intended use for the certificate.

Syntax

anthropiccontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (Anthropic Control)

The certificate's version number.

Syntax

anthropiccontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (Anthropic Control)

The subject of the certificate used for client authentication.

Syntax

anthropiccontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name properties and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common properties and their meanings are as follows:

If a property value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (Anthropic Control)

The certificate (PEM/Base64 encoded).

Syntax

anthropiccontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

StopSequences Property (Anthropic Control)

A comma-separated list of sequences where the model should stop generating.

Syntax

anthropiccontrol.StopSequences[=string]

Default Value

""

Remarks

This property specifies up to a handful of sequences, separated by commas, at which the model will stop generating further tokens. For example, setting this to END,STOP causes generation to stop as soon as either END or STOP is produced.

When generation stops for this reason, the StopReason configuration setting reports stop_sequence.

When this property is left empty (the default), the stop_sequences field is omitted from the request.

This property is not available at design time.

Data Type

String

Stream Property (Anthropic Control)

Whether the reply should be streamed.

Syntax

anthropiccontrol.Stream[=boolean]

Default Value

False

Remarks

When this property is set to True, CreateMessage sends the request with streaming enabled and the ContentBlockDelta event fires once for each incremental fragment of the reply as it is received.

In both cases, once the reply has been fully received it is appended to Messages as a new item, and the ToolUse event fires for each tool the model called.

The default value is False.

This property is not available at design time.

Data Type

Boolean

SystemPrompt Property (Anthropic Control)

The system prompt sent alongside the conversation.

Syntax

anthropiccontrol.SystemPrompt[=string]

Default Value

""

Remarks

This property specifies the system prompt, which gives the model context and instructions that apply to the whole conversation, such as a role to adopt or a goal to pursue.

The Messages API does not accept a message whose role is system. The system prompt is instead a top level field of the request, which is what this property supplies.

When this property is left empty (the default), the system field is omitted from the request entirely.

The following example gives the model a role that applies to the whole conversation.

anthropic.SystemPrompt = "You are a concise assistant. Answer in one sentence."; anthropic.AddMessage("user", "What is the capital of France?"); anthropic.CreateMessage();

In the Async Edition (nsoftware.async.IPWorksLLM), the property is set the same way and the request is awaited:

anthropic.SystemPrompt = "You are a concise assistant. Answer in one sentence."; await anthropic.AddMessage("user", "What is the capital of France?"); await anthropic.CreateMessage();

This property is not available at design time.

Data Type

String

Temperature Property (Anthropic Control)

The sampling temperature to use for the reply.

Syntax

anthropiccontrol.Temperature[=string]

Default Value

""

Remarks

This property specifies the amount of randomness injected into the response, typically ranging from 0.0 to 1.0. Higher values make the output more varied, while lower values make it more focused and deterministic.

When this property is left empty (the default), the temperature field is omitted from the request and the server's own default is used.

This property is not available at design time.

Data Type

String

Timeout Property (Anthropic Control)

The timeout for operations in seconds.

Syntax

anthropiccontrol.Timeout[=integer]

Default Value

60

Remarks

This property specifies the timeout period in seconds for operations performed by the control.

If this is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If this is set to a positive value, the control will wait for the operation to complete before returning control. If the timeout expires before the operation completes, the control throws an exception.

Note that all timeouts are inactivity timeouts, meaning the timeout period is extended by value specified in this property when any amount of data is successfully sent or received.

This property is not available at design time.

Data Type

Integer

ToolCount Property (Anthropic Control)

The number of records in the Tool arrays.

Syntax

anthropiccontrol.ToolCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ToolDescription
• ToolInputSchema
• ToolName

The array indices start at 0 and end at ToolCount - 1.

This property is not available at design time.

Data Type

Integer

ToolDescription Property (Anthropic Control)

A description of what the tool does.

Syntax

anthropiccontrol.ToolDescription(ToolIndex)[=string]

Default Value

""

Remarks

A description of what the tool does.

This property holds a natural language description of what the tool does and when it should be used. A thorough description materially improves the model's ability to choose the tool appropriately.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ToolCount property.

This property is not available at design time.

Data Type

String

ToolInputSchema Property (Anthropic Control)

The raw JSON Schema describing the tool's input.

Syntax

anthropiccontrol.ToolInputSchema(ToolIndex)[=string]

Default Value

""

Remarks

The raw JSON Schema describing the tool's input.

This property holds the raw JSON Schema object describing the input the tool expects, as built from calls to AddToolParam or as set directly. When left empty, a schema equivalent to {"type": "object"} (no input) is used.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ToolCount property.

This property is not available at design time.

Data Type

String

ToolName Property (Anthropic Control)

The unique name associated with the tool.

Syntax

anthropiccontrol.ToolName(ToolIndex)[=string]

Default Value

""

Remarks

The unique name associated with the tool.

This property identifies the unique name associated with the tool. The model uses this name when it calls the tool, and it is reported as the Name parameter of the ToolUse event.

The ToolIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ToolCount property.

This property is not available at design time.

Data Type

String

TopK Property (Anthropic Control)

The number of top choices the model samples from.

Syntax

anthropiccontrol.TopK[=integer]

Default Value

0

Remarks

This property specifies that the model should sample only from the given number of most likely tokens at each step, which removes long tail low probability responses.

When this property is left at 0 (the default), the top_k field is omitted from the request and the server's own default is used.

This property is not available at design time.

Data Type

Integer

TopP Property (Anthropic Control)

The nucleus sampling cutoff to use for the reply.

Syntax

anthropiccontrol.TopP[=string]

Default Value

""

Remarks

This property specifies the cumulative probability cutoff used for nucleus sampling, typically ranging from 0.0 to 1.0. The model considers only the most likely tokens whose probabilities sum to this value.

When this property is left empty (the default), the top_p field is omitted from the request and the server's own default is used.

Anthropic recommends adjusting either this property or Temperature, but not both.

This property is not available at design time.

Data Type

String

AddMessage Method (Anthropic Control)

Appends a message to the Messages collection.

Syntax

anthropiccontrol.AddMessage Role, Content

Remarks

This method appends a new message with the given Role (user or assistant) and Content to the Messages properties. It is a convenience equivalent to adding an item to the collection directly.

Content normally holds plain text, which is sent as a single text content block. When Content instead begins with [, it is treated as a raw JSON content block array and sent verbatim, which is how blocks such as image or tool_result are supplied.

A system prompt cannot be added through this method; use the SystemPrompt property instead.

AddTool Method (Anthropic Control)

Appends a tool to the Tools collection.

Syntax

anthropiccontrol.AddTool Name, Description

Remarks

This method appends a new anthropictool item, with the given Name and Description, to the Tools properties.

Any parameters queued by prior calls to AddToolParam are consumed and used to build the new tool's input schema; the parameter queue is then cleared.

Example: anthropic.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); anthropic.AddTool("get_weather", "Gets the current weather for a location.");

In the Async Edition (nsoftware.async.IPWorksLLM), both calls are awaited:

await anthropic.AddToolParam("location", "string", "The city and state, e.g. San Francisco, CA", true); await anthropic.AddTool("get_weather", "Gets the current weather for a location.");

AddToolParam Method (Anthropic Control)

Queues a parameter to be included in the next tool added via AddTool.

Syntax

anthropiccontrol.AddToolParam Name, ParamType, Description, Required

Remarks

This method queues a parameter to be included in the JSON Schema of the next tool appended via AddTool.

Name specifies the parameter's name.

ParamType specifies the parameter's JSON Schema type, such as string, number, boolean, or object.

Description specifies a natural language description of the parameter, which helps the model determine appropriate values for it.

Required specifies whether the model must supply a value for this parameter whenever it uses the tool.

Queued parameters are consumed, and the queue is cleared, the next time AddTool is called.

Config Method (Anthropic Control)

Sets or retrieves a configuration setting.

Syntax

anthropiccontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CountTokens Method (Anthropic Control)

Counts the tokens the current conversation would consume.

Syntax

anthropiccontrol.CountTokens 

Remarks

This method sends the entire Messages properties, together with SystemPrompt and Tools, to {ServerURL}/messages/count_tokens and returns the number of input tokens the model would consume. No reply is generated and nothing is appended to Messages.

This is useful for checking a conversation against a model's context window, or for estimating cost, before sending it.

The Model property must be set before calling this method. MaxTokens is not required, because the token counting endpoint does not generate any output.

The following example measures a conversation before paying to send it.

anthropic.Model = "claude-sonnet-5"; anthropic.AddMessage("user", "What is the capital of France?"); int inputTokens = anthropic.CountTokens();

In the Async Edition (nsoftware.async.IPWorksLLM), the same operation is awaited:

anthropic.Model = "claude-sonnet-5"; await anthropic.AddMessage("user", "What is the capital of France?"); int inputTokens = await anthropic.CountTokens();

CreateMessage Method (Anthropic Control)

Sends the current conversation to the model and appends the reply.

Syntax

anthropiccontrol.CreateMessage 

Remarks

This method sends the entire Messages properties, together with SystemPrompt, Tools, and every request property that has been set away from its default value, to {ServerURL}/messages. Properties left at their default values are omitted from the request JSON.

On success, the assistant's reply is appended to Messages as a new item. When the reply is a single block of text, that text is stored directly; when the reply holds several blocks, or any block that is not text, the raw content block array is stored instead so that the assistant turn can be reproduced exactly.

When the model calls one or more tools, the ToolUse event fires once for each call. To continue the conversation, append a message with role user whose content is a raw content block array holding the matching tool_result blocks, then call this method again.

The Model property must be set, and MaxTokens must be set to a positive value, before calling this method.

The following example sends a short conversation and reads the reply back out of Messages.

anthropic.APIKey = "sk-ant-..."; anthropic.Model = "claude-sonnet-5"; anthropic.MaxTokens = 1024; anthropic.AddMessage("user", "What is the capital of France?"); anthropic.CreateMessage(); string reply = anthropic.Messages[anthropic.Messages.Count - 1].Content;

In the Async Edition (nsoftware.async.IPWorksLLM), the same operation is awaited:

anthropic.APIKey = "sk-ant-..."; anthropic.Model = "claude-sonnet-5"; anthropic.MaxTokens = 1024; await anthropic.AddMessage("user", "What is the capital of France?"); await anthropic.CreateMessage(); string reply = anthropic.Messages[anthropic.Messages.Count - 1].Content;

DoEvents Method (Anthropic Control)

This method processes events from the internal message queue.

Syntax

anthropiccontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (Anthropic Control)

This method interrupts the current method.

Syntax

anthropiccontrol.Interrupt 

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListModels Method (Anthropic Control)

Retrieves the list of models available from the endpoint.

Syntax

anthropiccontrol.ListModels 

Remarks

This method sends a request to {ServerURL}/models. The ModelList event fires once for each model reported by the server.

This method is typically used to discover which model identifiers are valid for the Model property.

The endpoint returns a single page of results. This method reports the models on that first page and does not follow the cursor to any subsequent page.

Reset Method (Anthropic Control)

This method will reset the control.

Syntax

anthropiccontrol.Reset 

Remarks

This method will reset the control's properties to their default values.

Connected Event (Anthropic Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub anthropiccontrol_Connected(StatusCode As Integer, Description As String)

Remarks

If the connection is made normally, StatusCode is 0 and Description is 'OK'.

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (Anthropic Control)

Fired to indicate changes in the connection state.

Syntax

Sub anthropiccontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

ContentBlockDelta Event (Anthropic Control)

Fires once for each incremental fragment of a streamed reply.

Syntax

Sub anthropiccontrol_ContentBlockDelta(Index As Integer, DeltaType As String, Delta As String)

Remarks

This event fires when Stream is set to True and CreateMessage is called. It fires once for each incremental fragment of the reply as it is received from the server.

Index holds the zero based position, within the reply's content block array, of the block this fragment belongs to. A reply may build several blocks, and fragments for a later block only begin arriving once the previous block is complete.

DeltaType holds the wire type of the fragment. A value of text_delta means Delta carries a fragment of visible text; a value of input_json_delta means Delta carries a fragment of the JSON input of a tool the model is calling; a value of thinking_delta means Delta carries a fragment of the model's thinking, and a value of signature_delta means Delta carries a fragment of the opaque signature that closes a thinking block. Other values may be introduced by the API over time; such fragments are still surfaced, with DeltaType set to the value the server sent and Delta empty.

Delta holds the fragment itself. Concatenating Delta across every occurrence of this event that shares one Index and one DeltaType reconstructs the text_delta, input_json_delta, thinking_delta and signature_delta content of that block, and no other delta type contributes to it; the assembled reply is also appended to Messages once streaming completes. A streamed thinking block is retained with both its text and its signature, the same shape a non-streamed reply keeps, so that it can be passed back unchanged on the next request.

The following example prints the visible text of the reply as it arrives, ignoring every other delta type.

anthropic.Stream = true; anthropic.OnContentBlockDelta += (s, e) => { if (e.DeltaType == "text_delta") Console.Write(e.Delta); }; anthropic.AddMessage("user", "Write a short poem about the sea."); anthropic.CreateMessage();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and the request is awaited:

anthropic.Stream = true; anthropic.OnContentBlockDelta += async (s, e) => { if (e.DeltaType == "text_delta") Console.Write(e.Delta); }; await anthropic.AddMessage("user", "Write a short poem about the sea."); await anthropic.CreateMessage();

Disconnected Event (Anthropic Control)

Fired when a connection is closed.

Syntax

Sub anthropiccontrol_Disconnected(StatusCode As Integer, Description As String)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is 'OK'.

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

EndTransfer Event (Anthropic Control)

Fired when a document finishes transferring.

Syntax

Sub anthropiccontrol_EndTransfer(Direction As Integer)

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (Anthropic Control)

Fired when information is available about errors during data delivery.

Syntax

Sub anthropiccontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (Anthropic Control)

Fired every time a header line comes in.

Syntax

Sub anthropiccontrol_Header(Field As String, Value As String)

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains '' (empty string).

Log Event (Anthropic Control)

Fired once for each log message.

Syntax

Sub anthropiccontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

ModelList Event (Anthropic Control)

Fires once for each model reported by the server.

Syntax

Sub anthropiccontrol_ModelList(Id As String, DisplayName As String)

Remarks

This event fires once for each model returned in response to a call to ListModels.

Id holds the model's identifier, as would be supplied to Model. DisplayName holds a human readable name for the model.

Redirect Event (Anthropic Control)

Fired when a redirection is received from the server.

Syntax

Sub anthropiccontrol_Redirect(Location As String, Accept As Boolean)

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the control fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (Anthropic Control)

Fired for every cookie set by the server.

Syntax

Sub anthropiccontrol_SetCookie(Name As String, Value As String, Expires As String, Domain As String, Path As String, Secure As Boolean)

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (Anthropic Control)

Fired after the server presents its certificate to the client.

Syntax

Sub anthropiccontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Anthropic Control)

Fired when secure connection progress messages are available.

Syntax

Sub anthropiccontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (Anthropic Control)

Fired when a document starts transferring (after the headers).

Syntax

Sub anthropiccontrol_StartTransfer(Direction As Integer)

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (Anthropic Control)

Fired when the HTTP status line is received from the server.

Syntax

Sub anthropiccontrol_Status(HTTPVersion As String, StatusCode As Integer, Description As String)

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

ToolUse Event (Anthropic Control)

Fires once for each tool the model calls.

Syntax

Sub anthropiccontrol_ToolUse(Id As String, Name As String, InputJson As String)

Remarks

This event fires when the model's reply contains one or more tool_use content blocks, once per block. It fires for both streamed and non streamed replies.

Id is the model assigned identifier of the call, Name is the tool name, and InputJson holds the JSON input object the model produced for it.

To continue the conversation, append a message with role user whose content is a raw content block array holding a tool_result block whose tool_use_id is Id and whose content is the tool's result, then call CreateMessage again.

The following example returns the tool's result and lets the model produce a final reply.

anthropic.OnToolUse += (s, e) => { anthropic.AddMessage("user", "[{\"type\":\"tool_result\",\"tool_use_id\":\"" + e.Id + "\"," + " \"content\":\"" + GetWeather(e.InputJson) + "\"}]"); }; anthropic.AddMessage("user", "What is the weather like in Boston?"); anthropic.CreateMessage(); // A tool result was appended above, so send again for the final answer. if (anthropic.Config("StopReason") == "tool_use") anthropic.CreateMessage();

In the Async Edition (nsoftware.async.IPWorksLLM), the handler returns a task and each request is awaited:

anthropic.OnToolUse += async (s, e) => { await anthropic.AddMessage("user", "[{\"type\":\"tool_result\",\"tool_use_id\":\"" + e.Id + "\"," + " \"content\":\"" + GetWeather(e.InputJson) + "\"}]"); }; await anthropic.AddMessage("user", "What is the weather like in Boston?"); await anthropic.CreateMessage(); if (await anthropic.Config("StopReason") == "tool_use") await anthropic.CreateMessage();

Transfer Event (Anthropic Control)

Fired while a document transfers (delivers document).

Syntax

Sub anthropiccontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (Anthropic Control)

Anthropic Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (Anthropic Control)

Anthropic Errors

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors