RSS Control

Properties   Methods   Events   Config Settings   Errors  

The RSS Control is used to retrieve, parse, edit, and write RSS-syndicated content.

Syntax

RSS

Remarks

The RSS Control supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The RSS Control implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

The control contains a number of properties that map directly to RSS fields. To receive a feed, call the GetFeed method with the URL or file to retrieve as specified in the URL parameter. The RSS control also can generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.

The RSS Control supports all RSS feed properties that are standard in versions 0.91, 0.92, and 2.0 of the RSS protocol through a number of control properties. It also supports nonstandard properties as specified in the RSS protocol through the Namespaces properties and the GetProperty and SetProperty methods.

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.

Accept Property (RSS Control)

This property includes a list of acceptable MIME types for the request.

Syntax

rsscontrol.Accept[=string]

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

Data Type

String

Authorization Property (RSS Control)

This property includes the Authorization string to be sent to the server.

Syntax

rsscontrol.Authorization[=string]

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP control can be extended with other security schemes in addition to the authorization schemes already implemented by the control.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Data Type

String

AuthScheme Property (RSS Control)

This property specifies the authentication scheme to use when server authentication is required.

Syntax

rsscontrol.AuthScheme[=integer]

Possible Values

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

Default Value

0

Remarks

This property will tell the control which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the control will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the control.

For security, changing the value of this property will cause the control to clear the values of User, Password, and Authorization.

Data Type

Integer

ChannelCategory Property (RSS Control)

The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy.

Syntax

rsscontrol.ChannelCategory[=string]

Default Value

""

Remarks

The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy. The conventions used to interpret an RSS channel's category depend upon the processor.

Data Type

String

ChannelCategoryDomain Property (RSS Control)

This property contains the URL indicating the definition of the current RSS channel's category.

Syntax

rsscontrol.ChannelCategoryDomain[=string]

Default Value

""

Remarks

This property contains the URL indicating the definition of the current RSS channel's category. This points to a location that defines the category indicated by the ChannelCategory property.

This property is not available at design time.

Data Type

String

ChannelCopyright Property (RSS Control)

This property contains the copyright information for the current RSS channel (500 character maximum).

Syntax

rsscontrol.ChannelCopyright[=string]

Default Value

""

Remarks

This property contains the copyright information for the current RSS channel (500 character maximum).

Data Type

String

ChannelDescription Property (RSS Control)

This property contains a textual description of the current RSS feed (500 character maximum required).

Syntax

rsscontrol.ChannelDescription[=string]

Default Value

""

Remarks

This property contains a textual description of the current RSS feed (500 character maximum required).

This property is filled in automatically after calling GetFeed.

Required fields for building RSS feeds include the Channel's ChannelLink, ChannelTitle, and ChannelDescription fields.

Data Type

String

ChannelDocs Property (RSS Control)

This property should contain the URL for the documentation describing the format that was used to create the current RSS channel.

Syntax

rsscontrol.ChannelDocs[=string]

Default Value

"http://backend.userland.com/rss2"

Remarks

This property should contain the URL for the documentation describing the format that was used to create the current RSS channel. The default value points to the standard RSS 2.0 documentation found at "http://backend.userland.com/rss2".

Data Type

String

ChannelGenerator Property (RSS Control)

This property contains the name of the program that created the RSS feed.

Syntax

rsscontrol.ChannelGenerator[=string]

Default Value

"IPWorks Version 8.0 RSS Component"

Remarks

This property contains the name of the program that created the RSS feed.

Data Type

String

ChannelImageDescription Property (RSS Control)

This property is used to specify text that is included in the title attribute of the image's link formed in the HTML rendering.

Syntax

rsscontrol.ChannelImageDescription[=string]

Default Value

""

Remarks

This property is used to specify text that is included in the title attribute of the image's link formed in the HTML rendering.

Data Type

String

ChannelImageHeight Property (RSS Control)

This property contains the height of the image in pixels.

Syntax

rsscontrol.ChannelImageHeight[=string]

Default Value

""

Remarks

This property contains the height of the image in pixels.

Data Type

String

ChannelImageLink Property (RSS Control)

This property contains the URL associated with the channel's associated image.

Syntax

rsscontrol.ChannelImageLink[=string]

Default Value

""

Remarks

This property contains the URL associated with the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

Data Type

String

ChannelImageTitle Property (RSS Control)

This property contains the title of the channel's associated image.

Syntax

rsscontrol.ChannelImageTitle[=string]

Default Value

""

Remarks

This property contains the title of the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

Data Type

String

ChannelImageUrl Property (RSS Control)

This property contains the URL location of the channel's associated image.

Syntax

rsscontrol.ChannelImageUrl[=string]

Default Value

""

Remarks

This property contains the URL location of the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

Data Type

String

ChannelImageWidth Property (RSS Control)

This property contains the width of the image in pixels.

Syntax

rsscontrol.ChannelImageWidth[=string]

Default Value

""

Remarks

This property contains the width of the image in pixels.

Data Type

String

ChannelLanguage Property (RSS Control)

This property is required for feeds that conform to versions 0.

Syntax

rsscontrol.ChannelLanguage[=string]

Default Value

""

Remarks

This property is required for feeds that conform to versions 0.91 of the RSS protocol. It contains the language code used to identify the language of the current RSS channel.

Example. Language Codes:

For a detailed explanation about language codes, please refer to RFC 1766.

Data Type

String

ChannelLastBuildDate Property (RSS Control)

This property contains the date of the current RSS channel's most recent content changes.

Syntax

rsscontrol.ChannelLastBuildDate[=string]

Default Value

""

Remarks

This property contains the date of the current RSS channel's most recent content changes. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

Data Type

String

ChannelLink Property (RSS Control)

This property contains the URL that corresponds to the website where the RSS channel is located (500 character maximum required).

Syntax

rsscontrol.ChannelLink[=string]

Default Value

""

Remarks

This property contains the URL that corresponds to the website where the RSS channel is located (500 character maximum required).

This property is filled in automatically after calling GetFeed.

Required fields for building RSS feeds include the Channel's ChannelLink, ChannelTitle, and ChannelDescription fields.

Data Type

String

ChannelManagingEditor Property (RSS Control)

This property contains the email address or contact information for the current RSS channel's editor.

Syntax

rsscontrol.ChannelManagingEditor[=string]

Default Value

""

Remarks

This property contains the email address or contact information for the current RSS channel's editor.

Data Type

String

ChannelPubDate Property (RSS Control)

This property contains the date of the current RSS channel's most recent publication.

Syntax

rsscontrol.ChannelPubDate[=string]

Default Value

""

Remarks

This property contains the date of the current RSS channel's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

Data Type

String

ChannelSkipDays Property (RSS Control)

This property contains a list of days in which aggregators may skip reading the channel.

Syntax

rsscontrol.ChannelSkipDays[=string]

Default Value

""

Remarks

This property contains a list of days in which aggregators may skip reading the channel. When using this property, its value must contain "<day>" XML subelements. Each subelement's value must be a valid day of the week, such as Monday, Tuesday, Wednesday, and so on. Up to seven days may be specified for this property.

Data Type

String

ChannelSkipHours Property (RSS Control)

This property contains a list of hours in which aggregators may skip reading the channel.

Syntax

rsscontrol.ChannelSkipHours[=string]

Default Value

""

Remarks

This property contains a list of hours in which aggregators may skip reading the channel. When using this property, its value must contain "<hour>" XML subelements. Each subelement's value must be a valid hour between 0 and 23, representing a time in GMT. Up to 24 subelements may be specified for this property.

Note: Hour zero is the hour starting at midnight.

Data Type

String

ChannelTitle Property (RSS Control)

This property contains the title of the current RSS feed (40 character maximum required).

Syntax

rsscontrol.ChannelTitle[=string]

Default Value

""

Remarks

This property contains the title of the current RSS feed (40 character maximum required). Typically, the title of the channel is similar to that of the web page where the RSS content is hosted.

This property is filled in automatically after calling GetFeed.

Required fields for building RSS feeds include the Channel's ChannelLink, ChannelTitle, and ChannelDescription fields.

Data Type

String

ChannelTtl Property (RSS Control)

This property contains the number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

Syntax

rsscontrol.ChannelTtl[=string]

Default Value

""

Remarks

This property contains the number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

Data Type

String

ChannelWebMaster Property (RSS Control)

This property contains the email address or contact information for the current RSS channel's webmaster.

Syntax

rsscontrol.ChannelWebMaster[=string]

Default Value

""

Remarks

This property contains the email address or contact information for the current RSS channel's webmaster.

Data Type

String

Connected Property (RSS Control)

Whether the control is connected.

Syntax

rsscontrol.Connected

Default Value

False

Remarks

This property is used to determine whether or not the control is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Data Type

Boolean

CookieCount Property (RSS Control)

The number of records in the Cookie arrays.

Syntax

rsscontrol.CookieCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (RSS Control)

The domain of a received cookie.

Syntax

rsscontrol.CookieDomain(CookieIndex)

Default Value

""

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieExpiration Property (RSS Control)

An expiration time for the cookie (if provided by the server).

Syntax

rsscontrol.CookieExpiration(CookieIndex)

Default Value

""

Remarks

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, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieName Property (RSS Control)

The name of the cookie.

Syntax

rsscontrol.CookieName(CookieIndex)[=string]

Default Value

""

Remarks

The name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (RSS Control)

A path name to limit the cookie to (if provided by the server).

Syntax

rsscontrol.CookiePath(CookieIndex)

Default Value

""

Remarks

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

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieSecure Property (RSS Control)

The security flag of the received cookie.

Syntax

rsscontrol.CookieSecure(CookieIndex)

Default Value

False

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

Boolean

CookieValue Property (RSS Control)

The value of the cookie.

Syntax

rsscontrol.CookieValue(CookieIndex)[=string]

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (RSS Control)

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

Syntax

rsscontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (RSS Control)

The type of firewall to connect through.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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

FollowRedirects Property (RSS Control)

Determines what happens when the server issues a redirect.

Syntax

rsscontrol.FollowRedirects[=integer]

Possible Values

frNever(0), 
frAlways(1), 
frSameScheme(2)

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the control returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the control fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the control fails with an error instead.

Data Type

Integer

Idle Property (RSS Control)

The current status of the control.

Syntax

rsscontrol.Idle

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (RSS Control)

This property includes a date determining the maximum age of the desired document.

Syntax

rsscontrol.IfModifiedSince[=string]

Default Value

""

Remarks

If this property contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the control fails with an error

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

This property is not available at design time.

Data Type

String

ItemCount Property (RSS Control)

The number of records in the Item arrays.

Syntax

rsscontrol.ItemCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemAuthor
• ItemCategory
• ItemCategoryDomain
• ItemComments
• ItemDescription
• ItemEnclosureLength
• ItemEnclosureType
• ItemEnclosureUrl
• ItemGuid
• ItemGuidIsPermaLink
• ItemLink
• ItemPubDate
• ItemSource
• ItemSourceURL
• ItemTitle
• ItemXML

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

This property is not available at design time.

Data Type

Integer

ItemAuthor Property (RSS Control)

This property contains the email address or contact information for the current item's author.

Syntax

rsscontrol.ItemAuthor(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the email address or contact information for the current item's author.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCategory Property (RSS Control)

This property contains the location of the current item within a hierarchy.

Syntax

rsscontrol.ItemCategory(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the location of the current item within a hierarchy. The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy. The conventions used to interpret an RSS item's category depend on the processor.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCategoryDomain Property (RSS Control)

This property contains the URL indicating the definition of the current item's category.

Syntax

rsscontrol.ItemCategoryDomain(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the URL indicating the definition of the current item's category. This points to a location that defines the category indicated by the ItemCategory, which is provided in the Items properties.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemComments Property (RSS Control)

If present, this property should point to the URL location of a page for comments related to the current item.

Syntax

rsscontrol.ItemComments(ItemIndex)[=string]

Default Value

""

Remarks

If present, this property should point to the URL location of a page for comments related to the current item.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (RSS Control)

This property contains the description of the content of the current item.

Syntax

rsscontrol.ItemDescription(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the description of the content of the current item. For abstracts, ItemLink should point to the complete text of the item.

This property is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either a ItemTitle or ItemDescription defined.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemEnclosureLength Property (RSS Control)

This property indicates how large the enclosure is in bytes.

Syntax

rsscontrol.ItemEnclosureLength(ItemIndex)[=string]

Default Value

""

Remarks

This property indicates how large the enclosure is in bytes.

An enclosure specifies a media object that is attached to the item. The fields ItemEnclosureLength, ItemEnclosureType, and ItemEnclosureUrl all are required when specifying an enclosure.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemEnclosureType Property (RSS Control)

This property specifies the type of enclosure.

Syntax

rsscontrol.ItemEnclosureType(ItemIndex)[=string]

Default Value

""

Remarks

This property specifies the type of enclosure. This property must contain a standard MIME type, such as "audio/mpeg".

An enclosure specifies a media object that is attached to the item. The fields ItemEnclosureLength, ItemEnclosureType, and ItemEnclosureUrl all are required when specifying an enclosure.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemEnclosureUrl Property (RSS Control)

This property contains the URL where the enclosure is located.

Syntax

rsscontrol.ItemEnclosureUrl(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the URL where the enclosure is located.

An enclosure specifies a media object that is attached to the item. The fields ItemEnclosureLength, ItemEnclosureType, and ItemEnclosureUrl all are required when specifying an enclosure.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGuid Property (RSS Control)

This property contains the globally unique identifier for the current item.

Syntax

rsscontrol.ItemGuid(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the globally unique identifier for the current item. It is a string that uniquely identifies the item. Aggregators can use this property to determine whether or not an item is new.

Aggregators should view this value as a string, but it is up to the source of the feed to guarantee its uniqueness. The value may be the URL link to the full text of the item to help guarantee that it is unique.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGuidIsPermaLink Property (RSS Control)

When this property is set to True, the reader may assume that the guide is a permalink to the item.

Syntax

rsscontrol.ItemGuidIsPermaLink(ItemIndex)[=boolean]

Default Value

True

Remarks

When this property is set to True, the reader may assume that the guide is a permalink to the item. A permalink is a URL that can be opened in a web browser, which contains the full item contents from the original RSS feed.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Boolean

ItemXML Property (RSS Control)

This property contains the full XML contents of the item.

Syntax

rsscontrol.ItemXML(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the full XML contents of the item. Unless the properties of the RSS item are modified, this value will contain the original XML from the RSS feed.

Note: When setting this property, the entire contents of the item must be supplied, including the item tags. All previous item values will be lost.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemLink Property (RSS Control)

For headline or abstract items, this property should be the location of the full text of the item.

Syntax

rsscontrol.ItemLink(ItemIndex)[=string]

Default Value

""

Remarks

For headline or abstract items, this property should be the location of the full text of the item.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemPubDate Property (RSS Control)

This property contains the date of the current item's most recent publication.

Syntax

rsscontrol.ItemPubDate(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the date of the current item's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemSource Property (RSS Control)

This property contains the name of the RSS feed in which the item was originally published, derived from the feed's title.

Syntax

rsscontrol.ItemSource(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the name of the RSS feed in which the item was originally published, derived from the feed's title. If this property or ItemSourceURL are empty, they should be filled with the values contained in ItemTitle and ItemLink properties of the Channel before forwarding the feed from a news aggregator to a blog.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemSourceURL Property (RSS Control)

This property contains the URL location of the XML-version of the current item's source.

Syntax

rsscontrol.ItemSourceURL(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the URL location of the XML-version of the current item's source. This is required if ItemSource is defined. It is a URL that points to the XML representation of the source of the current item.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTitle Property (RSS Control)

This property contains the title or headline of the current item.

Syntax

rsscontrol.ItemTitle(ItemIndex)[=string]

Default Value

""

Remarks

This property contains the title or headline of the current item. This property is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either ItemTitle or ItemDescription defined.

This property should contain a short description of the item, or a headline if ItemDescription is defined.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

LocalFile Property (RSS Control)

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Syntax

rsscontrol.LocalFile[=string]

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through TransferredData and the Transfer event.

Data Type

String

LocalHost Property (RSS Control)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

rsscontrol.LocalHost[=string]

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NamespaceCount Property (RSS Control)

The number of records in the Namespace arrays.

Syntax

rsscontrol.NamespaceCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

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

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (RSS Control)

This property contains the Prefix for the Namespace .

Syntax

rsscontrol.NamespacePrefix(NamespaceIndex)[=string]

Default Value

""

Remarks

This property contains the NamespacePrefix for the Namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (RSS Control)

This property contains the namespace URI associated with the corresponding Prefix .

Syntax

rsscontrol.NamespaceURI(NamespaceIndex)[=string]

Default Value

""

Remarks

This property contains the namespace URI associated with the corresponding NamespacePrefix. This URL is usually pointing to the XML schema for the namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

OtherHeaders Property (RSS Control)

Other headers as determined by the user (optional).

Syntax

rsscontrol.OtherHeaders[=string]

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the control beyond what is provided.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (RSS Control)

The number of records in the ParsedHeader arrays.

Syntax

rsscontrol.ParsedHeaderCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (RSS Control)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

rsscontrol.ParsedHeaderField(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (RSS Control)

This property contains the header contents.

Syntax

rsscontrol.ParsedHeaderValue(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

Password Property (RSS Control)

This property includes a password if authentication is to be used.

Syntax

rsscontrol.Password[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the control will attempt to authenticate using the current user's credentials.

Data Type

String

ProxyAuthScheme Property (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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

Referer Property (RSS Control)

This property includes the referer URL/document (optional).

Syntax

rsscontrol.Referer[=string]

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

Data Type

String

RSSData Property (RSS Control)

This property includes the complete text of the RSS XML file.

Syntax

rsscontrol.RSSData[=string]

Default Value

""

Remarks

When retrieving RSS feeds through the GetFeed or HTML through the GetURL method, this property will contain the complete original text of the feed. When writing an RSS feed using the WriteFile method, the control RSSData will be generated from the existing properties.

This property is not available at design time.

Data Type

String

RSSVersion Property (RSS Control)

This property includes the RSS protocol version of the current RSS feed.

Syntax

rsscontrol.RSSVersion[=integer]

Possible Values

rssVersionUndefined(0), 
rssVersion091(1), 
rssVersion092(2), 
rssVersion200(3)

Default Value

3

Remarks

This property contains the protocol version to which the current RSS feed conforms. Each version has slightly different requirements and a different set of defined standard properties. When generating an RSS feed, the control will check this value and throw an error for missing required properties.

The following values are currently recognized by the control:

To set properties not defined in the given version, use the Namespaces properties, to list and define namespaces and the GetProperty and SetProperty methods, and to list and define each nonstandard property.

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (RSS Control)

The date on which this certificate becomes valid.

Syntax

rsscontrol.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 (RSS Control)

The date on which the certificate expires.

Syntax

rsscontrol.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 (RSS Control)

A comma-delimited list of extended key usage identifiers.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The issuer of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The private key of the certificate (if available).

Syntax

rsscontrol.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 (RSS Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The public key of the certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The serial number of the certificate encoded as a string.

Syntax

rsscontrol.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 (RSS Control)

The text description of the certificate's signature algorithm.

Syntax

rsscontrol.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 (RSS Control)

The name of the certificate store for the client certificate.

Syntax

rsscontrol.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 (RSS 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

rsscontrol.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 (RSS Control)

The type of certificate store for this certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (RSS Control)

The MD5 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The SHA-1 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The SHA-256 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The text description of UsageFlags .

Syntax

rsscontrol.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 (RSS Control)

The flags that show intended use for the certificate.

Syntax

rsscontrol.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 (RSS Control)

The certificate's version number.

Syntax

rsscontrol.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 (RSS Control)

The subject of the certificate used for client authentication.

Syntax

rsscontrol.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 fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (RSS Control)

The certificate (PEM/Base64 encoded).

Syntax

rsscontrol.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 (RSS Control)

The date on which this certificate becomes valid.

Syntax

rsscontrol.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 (RSS Control)

The date on which the certificate expires.

Syntax

rsscontrol.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 (RSS Control)

A comma-delimited list of extended key usage identifiers.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The issuer of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The private key of the certificate (if available).

Syntax

rsscontrol.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 (RSS Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The public key of the certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The serial number of the certificate encoded as a string.

Syntax

rsscontrol.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 (RSS Control)

The text description of the certificate's signature algorithm.

Syntax

rsscontrol.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 (RSS Control)

The name of the certificate store for the client certificate.

Syntax

rsscontrol.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 (RSS 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

rsscontrol.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 (RSS Control)

The type of certificate store for this certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (RSS Control)

The MD5 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The SHA-1 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The SHA-256 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The text description of UsageFlags .

Syntax

rsscontrol.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 (RSS Control)

The flags that show intended use for the certificate.

Syntax

rsscontrol.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 (RSS Control)

The certificate's version number.

Syntax

rsscontrol.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 (RSS Control)

The subject of the certificate used for client authentication.

Syntax

rsscontrol.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 fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (RSS Control)

The certificate (PEM/Base64 encoded).

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (RSS Control)

The date on which this certificate becomes valid.

Syntax

rsscontrol.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 (RSS Control)

The date on which the certificate expires.

Syntax

rsscontrol.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 (RSS Control)

A comma-delimited list of extended key usage identifiers.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The issuer of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The private key of the certificate (if available).

Syntax

rsscontrol.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 (RSS Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The public key of the certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.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 (RSS Control)

The serial number of the certificate encoded as a string.

Syntax

rsscontrol.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 (RSS Control)

The text description of the certificate's signature algorithm.

Syntax

rsscontrol.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 (RSS Control)

The name of the certificate store for the client certificate.

Syntax

rsscontrol.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 (RSS 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

rsscontrol.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 (RSS Control)

The type of certificate store for this certificate.

Syntax

rsscontrol.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 (RSS Control)

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

Syntax

rsscontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (RSS Control)

The MD5 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The SHA-1 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The SHA-256 hash of the certificate.

Syntax

rsscontrol.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 (RSS Control)

The text description of UsageFlags .

Syntax

rsscontrol.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 (RSS Control)

The flags that show intended use for the certificate.

Syntax

rsscontrol.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 (RSS Control)

The certificate's version number.

Syntax

rsscontrol.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 (RSS Control)

The subject of the certificate used for client authentication.

Syntax

rsscontrol.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 fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (RSS Control)

The certificate (PEM/Base64 encoded).

Syntax

rsscontrol.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

Timeout Property (RSS Control)

The timeout for the control.

Syntax

rsscontrol.Timeout[=integer]

Default Value

60

Remarks

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

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (RSS Control)

This property includes the contents of the last response from the server.

Syntax

rsscontrol.TransferredData

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

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

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

Data Type

Binary String

TransferredDataLimit Property (RSS Control)

This property includes the maximum number of bytes of data to be transferred.

Syntax

rsscontrol.TransferredDataLimit[=long64]

Default Value

0

Remarks

This property defines the maximum number of bytes of data to be transferred. The default value is zero, which means there is no limit to the amount of data the control will accumulate and parse. If this value is set to a number n that is greater than zero, the control will receive only the first n bytes of data from the server.

Data Type

Long64

TransferredHeaders Property (RSS Control)

The full set of headers as received from the server.

Syntax

rsscontrol.TransferredHeaders

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the control.

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

Data Type

String

User Property (RSS Control)

This property includes a user name if authentication is to be used.

Syntax

rsscontrol.User[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the control will attempt to authenticate using the current user's credentials.

Data Type

String

AddCookie Method (RSS Control)

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

rsscontrol.AddCookie CookieName, CookieValue

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddItem Method (RSS Control)

This method inserts a new item into the beginning of an RSS feed.

Syntax

rsscontrol.AddItem Title, Description, Link

Remarks

This method assumes that the items are new and more important than existing items and thus adds the item to the beginning of the current item list. This method requires the three standard fields Title, Description, and Link to be specified.

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 2. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

AddNamespace Method (RSS Control)

This method adds a namespace to the Namespaces properties.

Syntax

rsscontrol.AddNamespace Prefix, NamespaceURI

Remarks

This method adds a namespace to the Namespaces properties. Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

Config Method (RSS Control)

Sets or retrieves a configuration setting.

Syntax

rsscontrol.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.

DoEvents Method (RSS Control)

This method processes events from the internal message queue.

Syntax

rsscontrol.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.

GetFeed Method (RSS Control)

This method retrieves an RSS feed.

Syntax

rsscontrol.GetFeed URL

Remarks

This method retrieves documents using the HTTP GET method. The document contents are delivered in the RSSData property, as well as through the Transfer event, and the HTTP response headers through the Header event. If the LocalFile property has been set, the control will write the transferred data there.

The control will then attempt to parse the RSS feed, filling in the channel and item properties as it goes. The feed properties can be accessed either directly through the named properties, or through the GetProperty and SetProperty methods.

GetProperty Method (RSS Control)

This method gets the value of a specific RSS feed item element or attribute.

Syntax

rsscontrol.GetProperty PropertyName

Remarks

This method is intended to extend the functionality of the RSS control. It will get the value for a specific item element or attribute of this RSS feed. Property is the XPath of the element or attribute according to the following convention: root/element@attribute. The @attribute part is optional, and the root field can be any of the four following values:

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, this method will return the text portion of element.

Example. GetProperty:

RSSControl.GetProperty("item[5]/guid@isPermaLink") RSSControl.GetProperty("item[5]/link") RSSControl.GetProperty("/channel/title")

Note: To add nonstandard fields (i.e., fields that are not defined in the RSS specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces properties to define and list namespaces.

GetURL Method (RSS Control)

This method retrieves an RSS feed.

Syntax

rsscontrol.GetURL URL

Remarks

This method retrieves the document using the HTTP GET method. The document contents are delivered in the RSSData property, as well as through the Transfer event, and the HTTP response headers are delivered through the Header event. If the LocalFile property has been set, the control will write the transferred data there.

The control will not parse the data returned by the server. For more control over the retrieval of the item link, please use the HTTP control.

Interrupt Method (RSS Control)

This method interrupts the current method.

Syntax

rsscontrol.Interrupt 

Remarks

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

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

OPMLAttr Method (RSS Control)

This method returns the value of the attribute specified in the parameter.

Syntax

rsscontrol.OPMLAttr AttrName

Remarks

This method may be used to get the value of an attribute for an outline entry of an OPML document. The desired attribute must be specified in the parameter of this method. This method also must be invoked inside the OPMLOutline event.

Put Method (RSS Control)

This method sends data to the HTTP server using the HTTP PUT method.

Syntax

rsscontrol.Put URL

Remarks

This method sends data to the HTTP server. The data are taken from the PostData or AttachedFile properties. The server response text is received through the Transfer event, and the HTTP response headers are received through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well. The user normally should have assigned the correct values to User and Password or Authorization.

ReadFile Method (RSS Control)

This method loads an RSS file into the control.

Syntax

rsscontrol.ReadFile FileName

Remarks

This method loads an RSS file and attempts to parse it, filling in the properties as it goes. The feed properties can be accessed either directly through the named properties or through the GetProperty and SetProperty methods.

ReadOPML Method (RSS Control)

This method reads and parses an OPML file.

Syntax

rsscontrol.ReadOPML OPMLFile

Remarks

This method reads in the OPML file specified by OPMLFile. The control then parses the file and returns the data to the user in the OPMLHeader and OPMLOutline events.

Reset Method (RSS Control)

This method resets all properties of the control.

Syntax

rsscontrol.Reset 

Remarks

This method resets all properties to the control's default settings. This is an easy way to clear all of the property values before repopulating the RSS feed.

SetProperty Method (RSS Control)

This method sets the value of a specific RSS feed property.

Syntax

rsscontrol.SetProperty PropertyName, PropertyValue

Remarks

This method is intended to extend the functionality of the RSS control. It will set the value for a specific field of this RSS feed. Property is the name of the property according to the following convention: root/element@attribute. The root field can be any of the four following values:

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, Value will be placed in the text portion of element. Example. SetProperty:

RSSControl.SetProperty("item[5]/guid@isPermaLink", "true")

Note: To add nonstandard fields (i.e., fields that are not defined in the RSS specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces properties to define and list namespaces.

WriteFile Method (RSS Control)

This method writes an RSS feed from the control.

Syntax

rsscontrol.WriteFile FileName

Remarks

This method will write an RSS feed from the existing property values to FileName. The RSS feed will be preverified, and if there are any missing required fields, the control fails with an error.

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 3. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

Connected Event (RSS Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub rsscontrol_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 (RSS Control)

Fired to indicate changes in the connection state.

Syntax

Sub rsscontrol_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:

Disconnected Event (RSS Control)

Fired when a connection is closed.

Syntax

Sub rsscontrol_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 (RSS Control)

This event is fired when a document finishes transferring.

Syntax

Sub rsscontrol_EndTransfer(Direction As Integer)

Remarks

The EndTransfer event is fired 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 (RSS Control)

Fired when information is available about errors during data delivery.

Syntax

Sub rsscontrol_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 (RSS Control)

Fired every time a header line comes in.

Syntax

Sub rsscontrol_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 (RSS Control)

Fired once for each log message.

Syntax

Sub rsscontrol_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"

OPMLHeader Event (RSS Control)

This event is fired for each value in the header section of the current OPML document.

Syntax

Sub rsscontrol_OPMLHeader(Field As String, Value As String)

Remarks

This event is fired when the control is parsing an OPML document after a call to ReadOPML is made. The control parses each header field and value from the OPML document and fires OPMLHeader once for each header present.

OPMLOutline Event (RSS Control)

This event is fired for each outline in the current OPML document.

Syntax

Sub rsscontrol_OPMLOutline(Level As Integer, Text As String, TypeName As String, Title As String, URL As String, XMLURL As String, HTMLURL As String, Created As String, Description As String, OtherAttrs As String)

Remarks

This event is fired for each outline in the OPML document.

The Level parameter contains the depth of the current outline in the OPML document.

Each outline contains a Text attribute, which is parsed out, and returned in the Text parameter.

The Type attribute is a string that describes how the other attributes of the outline are interpreted and is returned in the TypeName parameter.

The Title parameter refers to the title of the outline.

The URL parameter indicates the external location of the outline.

The XMLURL parameter is usually set to an RSS, Atom, or OPML file.

The HTMLURL parameter specifies an HTMLURL attribute, which may be used instead of the URL attribute.

The Created parameter contains the date the outline node was created.

The OtherAttrs parameter contains a list of other attributes for the current outline. In this case, you must use the OPMLAttr method to get the attribute's corresponding values from the parser.

Redirect Event (RSS Control)

Fired when a redirection is received from the server.

Syntax

Sub rsscontrol_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 (RSS Control)

Fired for every cookie set by the server.

Syntax

Sub rsscontrol_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 (RSS Control)

Fired after the server presents its certificate to the client.

Syntax

Sub rsscontrol_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 (RSS Control)

Fired when secure connection progress messages are available.

Syntax

Sub rsscontrol_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 (RSS Control)

This event is fired when a document starts transferring (after the headers).

Syntax

Sub rsscontrol_StartTransfer(Direction As Integer)

Remarks

The StartTransfer event is fired 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 (RSS Control)

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

Syntax

Sub rsscontrol_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").

Transfer Event (RSS Control)

Fired while a document transfers (delivers document).

Syntax

Sub rsscontrol_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 (RSS Control)

RSS 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 (RSS Control)

RSS Errors

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

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

XML Errors