RSS Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

RSS

Remarks

The RSS Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over 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 via the Config method.

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

The class 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 class also can generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.

The RSS Class 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 class 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Accept Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccept();
int SetAccept(const char* lpszAccept);

Unicode (Windows)
LPWSTR GetAccept();
INT SetAccept(LPCWSTR lpszAccept);

char* ipworks_rss_getaccept(void* lpObj);
int ipworks_rss_setaccept(void* lpObj, const char* lpszAccept);

QString GetAccept();
int SetAccept(QString qsAccept);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* ipworks_rss_getauthorization(void* lpObj);
int ipworks_rss_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

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 Class)

The authentication scheme to use when server authentication is required.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Unicode (Windows)
INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5), 
AUTH_OAUTH(6)

int ipworks_rss_getauthscheme(void* lpObj);
int ipworks_rss_setauthscheme(void* lpObj, int iAuthScheme);

int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Default Value

0

Remarks

This property will tell the class 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 class 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 class.

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

Data Type

Integer

ChannelCategory Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelCategory();
int SetChannelCategory(const char* lpszChannelCategory);

Unicode (Windows)
LPWSTR GetChannelCategory();
INT SetChannelCategory(LPCWSTR lpszChannelCategory);

char* ipworks_rss_getchannelcategory(void* lpObj);
int ipworks_rss_setchannelcategory(void* lpObj, const char* lpszChannelCategory);

QString GetChannelCategory();
int SetChannelCategory(QString qsChannelCategory);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelCategoryDomain();
int SetChannelCategoryDomain(const char* lpszChannelCategoryDomain);

Unicode (Windows)
LPWSTR GetChannelCategoryDomain();
INT SetChannelCategoryDomain(LPCWSTR lpszChannelCategoryDomain);

char* ipworks_rss_getchannelcategorydomain(void* lpObj);
int ipworks_rss_setchannelcategorydomain(void* lpObj, const char* lpszChannelCategoryDomain);

QString GetChannelCategoryDomain();
int SetChannelCategoryDomain(QString qsChannelCategoryDomain);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelCopyright();
int SetChannelCopyright(const char* lpszChannelCopyright);

Unicode (Windows)
LPWSTR GetChannelCopyright();
INT SetChannelCopyright(LPCWSTR lpszChannelCopyright);

char* ipworks_rss_getchannelcopyright(void* lpObj);
int ipworks_rss_setchannelcopyright(void* lpObj, const char* lpszChannelCopyright);

QString GetChannelCopyright();
int SetChannelCopyright(QString qsChannelCopyright);

Default Value

""

Remarks

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

Data Type

String

ChannelDescription Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelDescription();
int SetChannelDescription(const char* lpszChannelDescription);

Unicode (Windows)
LPWSTR GetChannelDescription();
INT SetChannelDescription(LPCWSTR lpszChannelDescription);

char* ipworks_rss_getchanneldescription(void* lpObj);
int ipworks_rss_setchanneldescription(void* lpObj, const char* lpszChannelDescription);

QString GetChannelDescription();
int SetChannelDescription(QString qsChannelDescription);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelDocs();
int SetChannelDocs(const char* lpszChannelDocs);

Unicode (Windows)
LPWSTR GetChannelDocs();
INT SetChannelDocs(LPCWSTR lpszChannelDocs);

char* ipworks_rss_getchanneldocs(void* lpObj);
int ipworks_rss_setchanneldocs(void* lpObj, const char* lpszChannelDocs);

QString GetChannelDocs();
int SetChannelDocs(QString qsChannelDocs);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelGenerator();
int SetChannelGenerator(const char* lpszChannelGenerator);

Unicode (Windows)
LPWSTR GetChannelGenerator();
INT SetChannelGenerator(LPCWSTR lpszChannelGenerator);

char* ipworks_rss_getchannelgenerator(void* lpObj);
int ipworks_rss_setchannelgenerator(void* lpObj, const char* lpszChannelGenerator);

QString GetChannelGenerator();
int SetChannelGenerator(QString qsChannelGenerator);

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 Class)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelImageDescription();
int SetChannelImageDescription(const char* lpszChannelImageDescription);

Unicode (Windows)
LPWSTR GetChannelImageDescription();
INT SetChannelImageDescription(LPCWSTR lpszChannelImageDescription);

char* ipworks_rss_getchannelimagedescription(void* lpObj);
int ipworks_rss_setchannelimagedescription(void* lpObj, const char* lpszChannelImageDescription);

QString GetChannelImageDescription();
int SetChannelImageDescription(QString qsChannelImageDescription);

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 Class)

This property contains the height of the image in pixels.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelImageHeight();
int SetChannelImageHeight(const char* lpszChannelImageHeight);

Unicode (Windows)
LPWSTR GetChannelImageHeight();
INT SetChannelImageHeight(LPCWSTR lpszChannelImageHeight);

char* ipworks_rss_getchannelimageheight(void* lpObj);
int ipworks_rss_setchannelimageheight(void* lpObj, const char* lpszChannelImageHeight);

QString GetChannelImageHeight();
int SetChannelImageHeight(QString qsChannelImageHeight);

Default Value

""

Remarks

This property contains the height of the image in pixels.

Data Type

String

ChannelImageLink Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelImageLink();
int SetChannelImageLink(const char* lpszChannelImageLink);

Unicode (Windows)
LPWSTR GetChannelImageLink();
INT SetChannelImageLink(LPCWSTR lpszChannelImageLink);

char* ipworks_rss_getchannelimagelink(void* lpObj);
int ipworks_rss_setchannelimagelink(void* lpObj, const char* lpszChannelImageLink);

QString GetChannelImageLink();
int SetChannelImageLink(QString qsChannelImageLink);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelImageTitle();
int SetChannelImageTitle(const char* lpszChannelImageTitle);

Unicode (Windows)
LPWSTR GetChannelImageTitle();
INT SetChannelImageTitle(LPCWSTR lpszChannelImageTitle);

char* ipworks_rss_getchannelimagetitle(void* lpObj);
int ipworks_rss_setchannelimagetitle(void* lpObj, const char* lpszChannelImageTitle);

QString GetChannelImageTitle();
int SetChannelImageTitle(QString qsChannelImageTitle);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelImageUrl();
int SetChannelImageUrl(const char* lpszChannelImageUrl);

Unicode (Windows)
LPWSTR GetChannelImageUrl();
INT SetChannelImageUrl(LPCWSTR lpszChannelImageUrl);

char* ipworks_rss_getchannelimageurl(void* lpObj);
int ipworks_rss_setchannelimageurl(void* lpObj, const char* lpszChannelImageUrl);

QString GetChannelImageUrl();
int SetChannelImageUrl(QString qsChannelImageUrl);

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 Class)

This property contains the width of the image in pixels.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelImageWidth();
int SetChannelImageWidth(const char* lpszChannelImageWidth);

Unicode (Windows)
LPWSTR GetChannelImageWidth();
INT SetChannelImageWidth(LPCWSTR lpszChannelImageWidth);

char* ipworks_rss_getchannelimagewidth(void* lpObj);
int ipworks_rss_setchannelimagewidth(void* lpObj, const char* lpszChannelImageWidth);

QString GetChannelImageWidth();
int SetChannelImageWidth(QString qsChannelImageWidth);

Default Value

""

Remarks

This property contains the width of the image in pixels.

Data Type

String

ChannelLanguage Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLanguage();
int SetChannelLanguage(const char* lpszChannelLanguage);

Unicode (Windows)
LPWSTR GetChannelLanguage();
INT SetChannelLanguage(LPCWSTR lpszChannelLanguage);

char* ipworks_rss_getchannellanguage(void* lpObj);
int ipworks_rss_setchannellanguage(void* lpObj, const char* lpszChannelLanguage);

QString GetChannelLanguage();
int SetChannelLanguage(QString qsChannelLanguage);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLastBuildDate();
int SetChannelLastBuildDate(const char* lpszChannelLastBuildDate);

Unicode (Windows)
LPWSTR GetChannelLastBuildDate();
INT SetChannelLastBuildDate(LPCWSTR lpszChannelLastBuildDate);

char* ipworks_rss_getchannellastbuilddate(void* lpObj);
int ipworks_rss_setchannellastbuilddate(void* lpObj, const char* lpszChannelLastBuildDate);

QString GetChannelLastBuildDate();
int SetChannelLastBuildDate(QString qsChannelLastBuildDate);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLink();
int SetChannelLink(const char* lpszChannelLink);

Unicode (Windows)
LPWSTR GetChannelLink();
INT SetChannelLink(LPCWSTR lpszChannelLink);

char* ipworks_rss_getchannellink(void* lpObj);
int ipworks_rss_setchannellink(void* lpObj, const char* lpszChannelLink);

QString GetChannelLink();
int SetChannelLink(QString qsChannelLink);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelManagingEditor();
int SetChannelManagingEditor(const char* lpszChannelManagingEditor);

Unicode (Windows)
LPWSTR GetChannelManagingEditor();
INT SetChannelManagingEditor(LPCWSTR lpszChannelManagingEditor);

char* ipworks_rss_getchannelmanagingeditor(void* lpObj);
int ipworks_rss_setchannelmanagingeditor(void* lpObj, const char* lpszChannelManagingEditor);

QString GetChannelManagingEditor();
int SetChannelManagingEditor(QString qsChannelManagingEditor);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelPubDate();
int SetChannelPubDate(const char* lpszChannelPubDate);

Unicode (Windows)
LPWSTR GetChannelPubDate();
INT SetChannelPubDate(LPCWSTR lpszChannelPubDate);

char* ipworks_rss_getchannelpubdate(void* lpObj);
int ipworks_rss_setchannelpubdate(void* lpObj, const char* lpszChannelPubDate);

QString GetChannelPubDate();
int SetChannelPubDate(QString qsChannelPubDate);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelSkipDays();
int SetChannelSkipDays(const char* lpszChannelSkipDays);

Unicode (Windows)
LPWSTR GetChannelSkipDays();
INT SetChannelSkipDays(LPCWSTR lpszChannelSkipDays);

char* ipworks_rss_getchannelskipdays(void* lpObj);
int ipworks_rss_setchannelskipdays(void* lpObj, const char* lpszChannelSkipDays);

QString GetChannelSkipDays();
int SetChannelSkipDays(QString qsChannelSkipDays);

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 onn. Up to seven days may be specified for this property.

Data Type

String

ChannelSkipHours Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelSkipHours();
int SetChannelSkipHours(const char* lpszChannelSkipHours);

Unicode (Windows)
LPWSTR GetChannelSkipHours();
INT SetChannelSkipHours(LPCWSTR lpszChannelSkipHours);

char* ipworks_rss_getchannelskiphours(void* lpObj);
int ipworks_rss_setchannelskiphours(void* lpObj, const char* lpszChannelSkipHours);

QString GetChannelSkipHours();
int SetChannelSkipHours(QString qsChannelSkipHours);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelTitle();
int SetChannelTitle(const char* lpszChannelTitle);

Unicode (Windows)
LPWSTR GetChannelTitle();
INT SetChannelTitle(LPCWSTR lpszChannelTitle);

char* ipworks_rss_getchanneltitle(void* lpObj);
int ipworks_rss_setchanneltitle(void* lpObj, const char* lpszChannelTitle);

QString GetChannelTitle();
int SetChannelTitle(QString qsChannelTitle);

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 Class)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelTtl();
int SetChannelTtl(const char* lpszChannelTtl);

Unicode (Windows)
LPWSTR GetChannelTtl();
INT SetChannelTtl(LPCWSTR lpszChannelTtl);

char* ipworks_rss_getchannelttl(void* lpObj);
int ipworks_rss_setchannelttl(void* lpObj, const char* lpszChannelTtl);

QString GetChannelTtl();
int SetChannelTtl(QString qsChannelTtl);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelWebMaster();
int SetChannelWebMaster(const char* lpszChannelWebMaster);

Unicode (Windows)
LPWSTR GetChannelWebMaster();
INT SetChannelWebMaster(LPCWSTR lpszChannelWebMaster);

char* ipworks_rss_getchannelwebmaster(void* lpObj);
int ipworks_rss_setchannelwebmaster(void* lpObj, const char* lpszChannelWebMaster);

QString GetChannelWebMaster();
int SetChannelWebMaster(QString qsChannelWebMaster);

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 Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworks_rss_getconnected(void* lpObj);
int ipworks_rss_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

CookieCount Property (RSS Class)

The number of records in the Cookie arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieCount();
int SetCookieCount(int iCookieCount);

Unicode (Windows)
INT GetCookieCount();
INT SetCookieCount(INT iCookieCount);

int ipworks_rss_getcookiecount(void* lpObj);
int ipworks_rss_setcookiecount(void* lpObj, int iCookieCount);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

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 Class)

This is the domain of a received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieDomain(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);

char* ipworks_rss_getcookiedomain(void* lpObj, int cookieindex);

QString GetCookieDomain(int iCookieIndex);

Default Value

""

Remarks

This is 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 Class)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieExpiration(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);

char* ipworks_rss_getcookieexpiration(void* lpObj, int cookieindex);

QString GetCookieExpiration(int iCookieIndex);

Default Value

""

Remarks

This property 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, 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 Class)

This property, contains the name of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, const char* lpszCookieName);

Unicode (Windows)
LPWSTR GetCookieName(INT iCookieIndex);
INT SetCookieName(INT iCookieIndex, LPCWSTR lpszCookieName);

char* ipworks_rss_getcookiename(void* lpObj, int cookieindex);
int ipworks_rss_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

Default Value

""

Remarks

This property, contains 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 Class)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookiePath(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);

char* ipworks_rss_getcookiepath(void* lpObj, int cookieindex);

QString GetCookiePath(int iCookieIndex);

Default Value

""

Remarks

This property 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 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 Class)

This property contains the security flag of the received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieSecure(int iCookieIndex);

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);

int ipworks_rss_getcookiesecure(void* lpObj, int cookieindex);

bool GetCookieSecure(int iCookieIndex);

Default Value

FALSE

Remarks

This property contains 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 Class)

This property contains the value of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, const char* lpszCookieValue);

Unicode (Windows)
LPWSTR GetCookieValue(INT iCookieIndex);
INT SetCookieValue(INT iCookieIndex, LPCWSTR lpszCookieValue);

char* ipworks_rss_getcookievalue(void* lpObj, int cookieindex);
int ipworks_rss_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Default Value

""

Remarks

This property contains 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 Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworks_rss_getfirewallautodetect(void* lpObj);
int ipworks_rss_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (RSS Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworks_rss_getfirewalltype(void* lpObj);
int ipworks_rss_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (RSS Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworks_rss_getfirewallhost(void* lpObj);
int ipworks_rss_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of 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 class fails with an error.

Data Type

String

FirewallPassword Property (RSS Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworks_rss_getfirewallpassword(void* lpObj);
int ipworks_rss_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains 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 class fails with an error.

Data Type

String

FirewallPort Property (RSS Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworks_rss_getfirewallport(void* lpObj);
int ipworks_rss_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains 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 Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworks_rss_getfirewalluser(void* lpObj);
int ipworks_rss_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FollowRedirects Property (RSS Class)

This property determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

FR_NEVER(0), 
FR_ALWAYS(1), 
FR_SAME_SCHEME(2)

int ipworks_rss_getfollowredirects(void* lpObj);
int ipworks_rss_setfollowredirects(void* lpObj, int iFollowRedirects);

int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class 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 class 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 class fails with an error instead.

Data Type

Integer

Idle Property (RSS Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_rss_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIfModifiedSince();
int SetIfModifiedSince(const char* lpszIfModifiedSince);

Unicode (Windows)
LPWSTR GetIfModifiedSince();
INT SetIfModifiedSince(LPCWSTR lpszIfModifiedSince);

char* ipworks_rss_getifmodifiedsince(void* lpObj);
int ipworks_rss_setifmodifiedsince(void* lpObj, const char* lpszIfModifiedSince);

QString GetIfModifiedSince();
int SetIfModifiedSince(QString qsIfModifiedSince);

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 class 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 Class)

The number of records in the Item arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemCount();
int SetItemCount(int iItemCount);

Unicode (Windows)
INT GetItemCount();
INT SetItemCount(INT iItemCount);

int ipworks_rss_getitemcount(void* lpObj);
int ipworks_rss_setitemcount(void* lpObj, int iItemCount);

int GetItemCount();
int SetItemCount(int iItemCount);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemAuthor(int iItemIndex);
int SetItemAuthor(int iItemIndex, const char* lpszItemAuthor);

Unicode (Windows)
LPWSTR GetItemAuthor(INT iItemIndex);
INT SetItemAuthor(INT iItemIndex, LPCWSTR lpszItemAuthor);

char* ipworks_rss_getitemauthor(void* lpObj, int itemindex);
int ipworks_rss_setitemauthor(void* lpObj, int itemindex, const char* lpszItemAuthor);

QString GetItemAuthor(int iItemIndex);
int SetItemAuthor(int iItemIndex, QString qsItemAuthor);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCategory(int iItemIndex);
int SetItemCategory(int iItemIndex, const char* lpszItemCategory);

Unicode (Windows)
LPWSTR GetItemCategory(INT iItemIndex);
INT SetItemCategory(INT iItemIndex, LPCWSTR lpszItemCategory);

char* ipworks_rss_getitemcategory(void* lpObj, int itemindex);
int ipworks_rss_setitemcategory(void* lpObj, int itemindex, const char* lpszItemCategory);

QString GetItemCategory(int iItemIndex);
int SetItemCategory(int iItemIndex, QString qsItemCategory);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCategoryDomain(int iItemIndex);
int SetItemCategoryDomain(int iItemIndex, const char* lpszItemCategoryDomain);

Unicode (Windows)
LPWSTR GetItemCategoryDomain(INT iItemIndex);
INT SetItemCategoryDomain(INT iItemIndex, LPCWSTR lpszItemCategoryDomain);

char* ipworks_rss_getitemcategorydomain(void* lpObj, int itemindex);
int ipworks_rss_setitemcategorydomain(void* lpObj, int itemindex, const char* lpszItemCategoryDomain);

QString GetItemCategoryDomain(int iItemIndex);
int SetItemCategoryDomain(int iItemIndex, QString qsItemCategoryDomain);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemComments(int iItemIndex);
int SetItemComments(int iItemIndex, const char* lpszItemComments);

Unicode (Windows)
LPWSTR GetItemComments(INT iItemIndex);
INT SetItemComments(INT iItemIndex, LPCWSTR lpszItemComments);

char* ipworks_rss_getitemcomments(void* lpObj, int itemindex);
int ipworks_rss_setitemcomments(void* lpObj, int itemindex, const char* lpszItemComments);

QString GetItemComments(int iItemIndex);
int SetItemComments(int iItemIndex, QString qsItemComments);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, const char* lpszItemDescription);

Unicode (Windows)
LPWSTR GetItemDescription(INT iItemIndex);
INT SetItemDescription(INT iItemIndex, LPCWSTR lpszItemDescription);

char* ipworks_rss_getitemdescription(void* lpObj, int itemindex);
int ipworks_rss_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

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 Class)

This property indicates how large the enclosure is in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemEnclosureLength(int iItemIndex);
int SetItemEnclosureLength(int iItemIndex, const char* lpszItemEnclosureLength);

Unicode (Windows)
LPWSTR GetItemEnclosureLength(INT iItemIndex);
INT SetItemEnclosureLength(INT iItemIndex, LPCWSTR lpszItemEnclosureLength);

char* ipworks_rss_getitemenclosurelength(void* lpObj, int itemindex);
int ipworks_rss_setitemenclosurelength(void* lpObj, int itemindex, const char* lpszItemEnclosureLength);

QString GetItemEnclosureLength(int iItemIndex);
int SetItemEnclosureLength(int iItemIndex, QString qsItemEnclosureLength);

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 Class)

This property specifies the type of enclosure.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemEnclosureType(int iItemIndex);
int SetItemEnclosureType(int iItemIndex, const char* lpszItemEnclosureType);

Unicode (Windows)
LPWSTR GetItemEnclosureType(INT iItemIndex);
INT SetItemEnclosureType(INT iItemIndex, LPCWSTR lpszItemEnclosureType);

char* ipworks_rss_getitemenclosuretype(void* lpObj, int itemindex);
int ipworks_rss_setitemenclosuretype(void* lpObj, int itemindex, const char* lpszItemEnclosureType);

QString GetItemEnclosureType(int iItemIndex);
int SetItemEnclosureType(int iItemIndex, QString qsItemEnclosureType);

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 Class)

This property contains the URL where the enclosure is located.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemEnclosureUrl(int iItemIndex);
int SetItemEnclosureUrl(int iItemIndex, const char* lpszItemEnclosureUrl);

Unicode (Windows)
LPWSTR GetItemEnclosureUrl(INT iItemIndex);
INT SetItemEnclosureUrl(INT iItemIndex, LPCWSTR lpszItemEnclosureUrl);

char* ipworks_rss_getitemenclosureurl(void* lpObj, int itemindex);
int ipworks_rss_setitemenclosureurl(void* lpObj, int itemindex, const char* lpszItemEnclosureUrl);

QString GetItemEnclosureUrl(int iItemIndex);
int SetItemEnclosureUrl(int iItemIndex, QString qsItemEnclosureUrl);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemGuid(int iItemIndex);
int SetItemGuid(int iItemIndex, const char* lpszItemGuid);

Unicode (Windows)
LPWSTR GetItemGuid(INT iItemIndex);
INT SetItemGuid(INT iItemIndex, LPCWSTR lpszItemGuid);

char* ipworks_rss_getitemguid(void* lpObj, int itemindex);
int ipworks_rss_setitemguid(void* lpObj, int itemindex, const char* lpszItemGuid);

QString GetItemGuid(int iItemIndex);
int SetItemGuid(int iItemIndex, QString qsItemGuid);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemGuidIsPermaLink(int iItemIndex);
int SetItemGuidIsPermaLink(int iItemIndex, int bItemGuidIsPermaLink);

Unicode (Windows)
BOOL GetItemGuidIsPermaLink(INT iItemIndex);
INT SetItemGuidIsPermaLink(INT iItemIndex, BOOL bItemGuidIsPermaLink);

int ipworks_rss_getitemguidispermalink(void* lpObj, int itemindex);
int ipworks_rss_setitemguidispermalink(void* lpObj, int itemindex, int bItemGuidIsPermaLink);

bool GetItemGuidIsPermaLink(int iItemIndex);
int SetItemGuidIsPermaLink(int iItemIndex, bool bItemGuidIsPermaLink);

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 Class)

This property contains the full XML contents of the item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemXML(int iItemIndex);
int SetItemXML(int iItemIndex, const char* lpszItemXML);

Unicode (Windows)
LPWSTR GetItemXML(INT iItemIndex);
INT SetItemXML(INT iItemIndex, LPCWSTR lpszItemXML);

char* ipworks_rss_getitemxml(void* lpObj, int itemindex);
int ipworks_rss_setitemxml(void* lpObj, int itemindex, const char* lpszItemXML);

QString GetItemXML(int iItemIndex);
int SetItemXML(int iItemIndex, QString qsItemXML);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemLink(int iItemIndex);
int SetItemLink(int iItemIndex, const char* lpszItemLink);

Unicode (Windows)
LPWSTR GetItemLink(INT iItemIndex);
INT SetItemLink(INT iItemIndex, LPCWSTR lpszItemLink);

char* ipworks_rss_getitemlink(void* lpObj, int itemindex);
int ipworks_rss_setitemlink(void* lpObj, int itemindex, const char* lpszItemLink);

QString GetItemLink(int iItemIndex);
int SetItemLink(int iItemIndex, QString qsItemLink);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemPubDate(int iItemIndex);
int SetItemPubDate(int iItemIndex, const char* lpszItemPubDate);

Unicode (Windows)
LPWSTR GetItemPubDate(INT iItemIndex);
INT SetItemPubDate(INT iItemIndex, LPCWSTR lpszItemPubDate);

char* ipworks_rss_getitempubdate(void* lpObj, int itemindex);
int ipworks_rss_setitempubdate(void* lpObj, int itemindex, const char* lpszItemPubDate);

QString GetItemPubDate(int iItemIndex);
int SetItemPubDate(int iItemIndex, QString qsItemPubDate);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemSource(int iItemIndex);
int SetItemSource(int iItemIndex, const char* lpszItemSource);

Unicode (Windows)
LPWSTR GetItemSource(INT iItemIndex);
INT SetItemSource(INT iItemIndex, LPCWSTR lpszItemSource);

char* ipworks_rss_getitemsource(void* lpObj, int itemindex);
int ipworks_rss_setitemsource(void* lpObj, int itemindex, const char* lpszItemSource);

QString GetItemSource(int iItemIndex);
int SetItemSource(int iItemIndex, QString qsItemSource);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemSourceURL(int iItemIndex);
int SetItemSourceURL(int iItemIndex, const char* lpszItemSourceURL);

Unicode (Windows)
LPWSTR GetItemSourceURL(INT iItemIndex);
INT SetItemSourceURL(INT iItemIndex, LPCWSTR lpszItemSourceURL);

char* ipworks_rss_getitemsourceurl(void* lpObj, int itemindex);
int ipworks_rss_setitemsourceurl(void* lpObj, int itemindex, const char* lpszItemSourceURL);

QString GetItemSourceURL(int iItemIndex);
int SetItemSourceURL(int iItemIndex, QString qsItemSourceURL);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTitle(int iItemIndex);
int SetItemTitle(int iItemIndex, const char* lpszItemTitle);

Unicode (Windows)
LPWSTR GetItemTitle(INT iItemIndex);
INT SetItemTitle(INT iItemIndex, LPCWSTR lpszItemTitle);

char* ipworks_rss_getitemtitle(void* lpObj, int itemindex);
int ipworks_rss_setitemtitle(void* lpObj, int itemindex, const char* lpszItemTitle);

QString GetItemTitle(int iItemIndex);
int SetItemTitle(int iItemIndex, QString qsItemTitle);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* ipworks_rss_getlocalfile(void* lpObj);
wchar_t* ipworks_rss_getlocalfile_W(void* lpObj); // Windows only
int ipworks_rss_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_rss_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_rss_getlocalhost(void* lpObj);
int ipworks_rss_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class 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 multi-homed 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 Class)

The number of records in the Namespace arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

Unicode (Windows)
INT GetNamespaceCount();
INT SetNamespaceCount(INT iNamespaceCount);

int ipworks_rss_getnamespacecount(void* lpObj);
int ipworks_rss_setnamespacecount(void* lpObj, int iNamespaceCount);

int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

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 Class)

The Prefix for the Namespace .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, const char* lpszNamespacePrefix);

Unicode (Windows)
LPWSTR GetNamespacePrefix(INT iNamespaceIndex);
INT SetNamespacePrefix(INT iNamespaceIndex, LPCWSTR lpszNamespacePrefix);

char* ipworks_rss_getnamespaceprefix(void* lpObj, int namespaceindex);
int ipworks_rss_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix);

Default Value

""

Remarks

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 Class)

Namespace URI associated with the corresponding Prefix .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, const char* lpszNamespaceURI);

Unicode (Windows)
LPWSTR GetNamespaceURI(INT iNamespaceIndex);
INT SetNamespaceURI(INT iNamespaceIndex, LPCWSTR lpszNamespaceURI);

char* ipworks_rss_getnamespaceuri(void* lpObj, int namespaceindex);
int ipworks_rss_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);

Default Value

""

Remarks

Namespace URI associated with the corresponding NamespacePrefix. This is usually a URL 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 Class)

This property includes other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworks_rss_getotherheaders(void* lpObj);
int ipworks_rss_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

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 ("\r\n") .

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 class beyond what is provided.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (RSS Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int ipworks_rss_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

char* ipworks_rss_getparsedheaderfield(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderField(int iParsedHeaderIndex);

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 Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

char* ipworks_rss_getparsedheadervalue(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworks_rss_getpassword(void* lpObj);
int ipworks_rss_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

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 class will attempt to authenticate using the current user's credentials.

Data Type

String

ProxyAuthScheme Property (RSS Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int ipworks_rss_getproxyauthscheme(void* lpObj);
int ipworks_rss_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which 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 component 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 class. Look at the configuration file for the class 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 Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int ipworks_rss_getproxyautodetect(void* lpObj);
int ipworks_rss_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (RSS Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* ipworks_rss_getproxypassword(void* lpObj);
int ipworks_rss_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword 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 Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int ipworks_rss_getproxyport(void* lpObj);
int ipworks_rss_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* ipworks_rss_getproxyserver(void* lpObj);
int ipworks_rss_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

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 Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int ipworks_rss_getproxyssl(void* lpObj);
int ipworks_rss_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines 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 Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* ipworks_rss_getproxyuser(void* lpObj);
int ipworks_rss_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReferer();
int SetReferer(const char* lpszReferer);

Unicode (Windows)
LPWSTR GetReferer();
INT SetReferer(LPCWSTR lpszReferer);

char* ipworks_rss_getreferer(void* lpObj);
int ipworks_rss_setreferer(void* lpObj, const char* lpszReferer);

QString GetReferer();
int SetReferer(QString qsReferer);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRSSData();
int SetRSSData(const char* lpszRSSData);

Unicode (Windows)
LPWSTR GetRSSData();
INT SetRSSData(LPCWSTR lpszRSSData);

char* ipworks_rss_getrssdata(void* lpObj);
int ipworks_rss_setrssdata(void* lpObj, const char* lpszRSSData);

QString GetRSSData();
int SetRSSData(QString qsRSSData);

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 class RSSData will be generated from the existing properties.

This property is not available at design time.

Data Type

String

RSSVersion Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRSSVersion();
int SetRSSVersion(int iRSSVersion);

Unicode (Windows)
INT GetRSSVersion();
INT SetRSSVersion(INT iRSSVersion);

RSS_VERSION_UNDEFINED(0), 
RSS_VERSION_091(1), 
RSS_VERSION_092(2), 
RSS_VERSION_200(3)

int ipworks_rss_getrssversion(void* lpObj);
int ipworks_rss_setrssversion(void* lpObj, int iRSSVersion);

int GetRSSVersion();
int SetRSSVersion(int iRSSVersion);

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 class will check this value and throw an error for missing required properties.

The following values are currently recognized by the class:

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

SSLAcceptServerCertEncoded Property (RSS Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworks_rss_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_rss_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is 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.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (RSS Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworks_rss_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_rss_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is 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.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (RSS Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworks_rss_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_rss_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworks_rss_getsslcertstorepassword(void* lpObj);
int ipworks_rss_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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 Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworks_rss_getsslcertstoretype(void* lpObj);
int ipworks_rss_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (RSS Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworks_rss_getsslcertsubject(void* lpObj);
int ipworks_rss_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is 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

SSLProvider Property (RSS Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworks_rss_getsslprovider(void* lpObj);
int ipworks_rss_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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 class 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:

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (RSS Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworks_rss_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is 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.

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

Data Type

Binary String

Timeout Property (RSS Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_rss_gettimeout(void* lpObj);
int ipworks_rss_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransferredData(char* &lpTransferredData, int &lenTransferredData);

Unicode (Windows)
INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);

int ipworks_rss_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);

QByteArray GetTransferredData();

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

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

Data Type

Binary String

TransferredDataLimit Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetTransferredDataLimit();
int SetTransferredDataLimit(int64 lTransferredDataLimit);

Unicode (Windows)
LONG64 GetTransferredDataLimit();
INT SetTransferredDataLimit(LONG64 lTransferredDataLimit);

int64 ipworks_rss_gettransferreddatalimit(void* lpObj);
int ipworks_rss_settransferreddatalimit(void* lpObj, int64 lTransferredDataLimit);

qint64 GetTransferredDataLimit();
int SetTransferredDataLimit(qint64 lTransferredDataLimit);

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 class will accumulate and parse. If this value is set to a number n that is greater than zero, the class will receive only the first n bytes of data from the server.

Data Type

Long64

TransferredHeaders Property (RSS Class)

This property includes the full set of headers as received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();

char* ipworks_rss_gettransferredheaders(void* lpObj);

QString GetTransferredHeaders();

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

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

Data Type

String

User Property (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworks_rss_getuser(void* lpObj);
int ipworks_rss_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

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 class will attempt to authenticate using the current user's credentials.

Data Type

String

AddCookie Method (RSS Class)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCookie(const char* lpszCookieName, const char* lpszCookieValue);

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);

int ipworks_rss_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);

Remarks

This property 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddItem Method (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddItem(const char* lpszTitle, const char* lpszDescription, const char* lpszLink);

Unicode (Windows)
INT AddItem(LPCWSTR lpszTitle, LPCWSTR lpszDescription, LPCWSTR lpszLink);

int ipworks_rss_additem(void* lpObj, const char* lpszTitle, const char* lpszDescription, const char* lpszLink);

int AddItem(const QString& qsTitle, const QString& qsDescription, const QString& qsLink);

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)

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddNamespace Method (RSS Class)

This method adds a namespace to the Namespaces properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddNamespace(const char* lpszPrefix, const char* lpszNamespaceURI);

Unicode (Windows)
INT AddNamespace(LPCWSTR lpszPrefix, LPCWSTR lpszNamespaceURI);

int ipworks_rss_addnamespace(void* lpObj, const char* lpszPrefix, const char* lpszNamespaceURI);

int AddNamespace(const QString& qsPrefix, const QString& qsNamespaceURI);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (RSS Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_rss_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (RSS Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_rss_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetFeed Method (RSS Class)

This method fetches an RSS feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFeed(const char* lpszURL);

Unicode (Windows)
INT GetFeed(LPCWSTR lpszURL);

int ipworks_rss_getfeed(void* lpObj, const char* lpszURL);

int GetFeed(const QString& qsURL);

Remarks

This method fetches 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 class will write the transferred data there.

The class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetProperty Method (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProperty(const char* lpszPropertyName);

Unicode (Windows)
LPWSTR GetProperty(LPCWSTR lpszPropertyName);

char* ipworks_rss_getproperty(void* lpObj, const char* lpszPropertyName);

QString GetProperty(const QString& qsPropertyName);

Remarks

This method is intended to extend the functionality of the RSS class. 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetURL Method (RSS Class)

This method fetches an RSS feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetURL(const char* lpszURL);

Unicode (Windows)
INT GetURL(LPCWSTR lpszURL);

int ipworks_rss_geturl(void* lpObj, const char* lpszURL);

int GetURL(const QString& qsURL);

Remarks

This method fetches 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 class will write the transferred data there.

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (RSS Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_rss_interrupt(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

OPMLAttr Method (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* OPMLAttr(const char* lpszAttrName);

Unicode (Windows)
LPWSTR OPMLAttr(LPCWSTR lpszAttrName);

char* ipworks_rss_opmlattr(void* lpObj, const char* lpszAttrName);

QString OPMLAttr(const QString& qsAttrName);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Put Method (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Put(const char* lpszURL);

Unicode (Windows)
INT Put(LPCWSTR lpszURL);

int ipworks_rss_put(void* lpObj, const char* lpszURL);

int Put(const QString& qsURL);

Remarks

This method sends data to the HTTP server. The data are taken from 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadFile Method (RSS Class)

This method loads an RSS file into the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadFile(const char* lpszFileName);

Unicode (Windows)
INT ReadFile(LPCWSTR lpszFileName);

int ipworks_rss_readfile(void* lpObj, const char* lpszFileName);

int ReadFile(const QString& qsFileName);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadOPML Method (RSS Class)

This method reads and parses an OPML file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadOPML(const char* lpszOPMLFile);

Unicode (Windows)
INT ReadOPML(LPCWSTR lpszOPMLFile);

int ipworks_rss_readopml(void* lpObj, const char* lpszOPMLFile);

int ReadOPML(const QString& qsOPMLFile);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (RSS Class)

This method resets all properties of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_rss_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetProperty Method (RSS Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetProperty(const char* lpszPropertyName, const char* lpszPropertyValue);

Unicode (Windows)
INT SetProperty(LPCWSTR lpszPropertyName, LPCWSTR lpszPropertyValue);

int ipworks_rss_setproperty(void* lpObj, const char* lpszPropertyName, const char* lpszPropertyValue);

int SetProperty(const QString& qsPropertyName, const QString& qsPropertyValue);

Remarks

This method is intended to extend the functionality of the RSS class. 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

WriteFile Method (RSS Class)

This method writes an RSS feed from the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteFile(const char* lpszFilename);

Unicode (Windows)
INT WriteFile(LPCWSTR lpszFilename);

int ipworks_rss_writefile(void* lpObj, const char* lpszFilename);

int WriteFile(const QString& qsFilename);

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 class 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)

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (RSS Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(RSSConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} RSSConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(RSSConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} RSSConnectedEventParams;

#define EID_RSS_CONNECTED 1

virtual INT IPWORKS_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class RSSConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(RSSConnectedEventParams *e);

// Or, subclass RSS and override this emitter function.
virtual int FireConnected(RSSConnectedEventParams *e) {...}

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.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (RSS Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(RSSConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} RSSConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(RSSConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} RSSConnectionStatusEventParams;

#define EID_RSS_CONNECTIONSTATUS 2

virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class RSSConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(RSSConnectionStatusEventParams *e);

// Or, subclass RSS and override this emitter function.
virtual int FireConnectionStatus(RSSConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus 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 Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(RSSDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} RSSDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(RSSDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} RSSDisconnectedEventParams;

#define EID_RSS_DISCONNECTED 3

virtual INT IPWORKS_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class RSSDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(RSSDisconnectedEventParams *e);

// Or, subclass RSS and override this emitter function.
virtual int FireDisconnected(RSSDisconnectedEventParams *e) {...}

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.

Please refer to the Error Codes section for more information.

EndTransfer Event (RSS Class)

This event is fired when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(RSSEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} RSSEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(RSSEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} RSSEndTransferEventParams;

#define EID_RSS_ENDTRANSFER 4

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class RSSEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(RSSEndTransferEventParams *e);

// Or, subclass RSS and override this emitter function.
virtual int FireEndTransfer(RSSEndTransferEventParams *e) {...}

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 Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(RSSErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} RSSErrorEventParams;


Unicode (Windows)
virtual INT FireError(RSSErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} RSSErrorEventParams;

#define EID_RSS_ERROR 5

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class RSSErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(RSSErrorEventParams *e);

// Or, subclass RSS and override this emitter function.
virtual int FireError(RSSErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 Class)

This event is fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(RSSHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} RSSHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(RSSHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} RSSHeaderEventParams;

#define EID_RSS_HEADER 6

virtual INT IPWORKS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class RSSHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(RSSHeaderEventParams *e);

// Or, subclass RSS and override this emitter function.
virtual int FireHeader(RSSHeaderEventParams *e) {...}

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 Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(RSSLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} RSSLogEventParams;


Unicode (Windows)
virtual INT FireLog(RSSLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} RSSLogEventParams;

#define EID_RSS_LOG 7

virtual INT IPWORKS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class RSSLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(RSSLogEventParams *e);

// Or, subclass RSS and override this emitter function.
virtual int FireLog(RSSLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. 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 Class)

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

Syntax

• C++
• C
• Qt