UserAgent Property  
 

Sets or returns the user agent string sent with provider requests.

Syntax

object.UserAgent [= value ]

Remarks

The UserAgent property returns or changes the user agent string included with HTTP requests sent to the current provider. User agent strings are commonly used to identify the client application, library, operating system, or application version associated with a request.

If this property is not explicitly set, the control will use a default user agent string that identifies the Windows platform, operating system version and SocketTools version. Applications may specify a custom user-agent string to identify their application when communicating with a provider. Some providers may use the user-agent string for logging, diagnostics, analytics, compatibility checks, or rate limiting. Certain providers may reject requests that do not include a valid user agent string.

If the ApplicationName property has been set, that value will also be included in the user-agent string sent to the server.

Changing the value of this property affects subsequent requests and does not modify requests that are already in progress. Applications should avoid including sensitive or personally identifiable information in the user-agent string because it may be recorded in provider logs or diagnostic systems.

If the llmOptionNoUserAgent option flag is specified in the Options property, the control will not include a user-agent header with requests, regardless of the value of this property.

You should only change this property value when necessary. Removing or changing the user-agent string does not make requests anonymous. Providers may still identify requests using other information such as API keys, account identifiers, IP addresses, or other request metadata.

Data Type

String

See Also

ApplicationName Property, Options Property, ProviderName Property, Ask Method, Connect Method, SendMessage Method