Atom Class

Properties   Methods   Events   Config Settings   Errors  

The Atom Class is used to retrieve, parse, and update Atom content.

Syntax

Atom

Remarks

The Atom class supports both plaintext and 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 Atom Class implements a standard Atom client as defined by RFC 4287 (http://www.ietf.org/rfc/rfc4287) and includes the Atom publishing capabilities as defined by the "The Atom Publishing Protocol" (http://www.ietf.org/rfc/rfc5023).

The class contains a number of properties that map directly to Atom fields. To receive a feed, call the GetFeed method with the URL or file to retrieve specified in the URL parameter. You may also update the Entries properties using the Put method.

The Atom Class supports all standard Atom properties and allows you to add your own through AddNamespace 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 (Atom 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_atom_getaccept(void* lpObj);
int ipworks_atom_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

AtomData Property (Atom Class)

This is the complete content of the Atom resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAtomData(char* &lpAtomData, int &lenAtomData);
int SetAtomData(const char* lpAtomData, int lenAtomData);

Unicode (Windows)
INT GetAtomData(LPSTR &lpAtomData, INT &lenAtomData);
INT SetAtomData(LPCSTR lpAtomData, INT lenAtomData);

int ipworks_atom_getatomdata(void* lpObj, char** lpAtomData, int* lenAtomData);
int ipworks_atom_setatomdata(void* lpObj, const char* lpAtomData, int lenAtomData);

QByteArray GetAtomData();
int SetAtomData(QByteArray qbaAtomData);

Default Value

""

Remarks

This property will contain the bytes received when retrieving Atom feeds or a media type through the GetResource method. When writing an Atom feed using the WriteFile method, the AtomData will be generated from the existing properties.

This property is not available at design time.

Data Type

Binary String

Authorization Property (Atom 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_atom_getauthorization(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getauthscheme(void* lpObj);
int ipworks_atom_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

ChannelAuthorEmail Property (Atom Class)

This property contains the email address of the author.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelAuthorEmail();
int SetChannelAuthorEmail(const char* lpszChannelAuthorEmail);

Unicode (Windows)
LPWSTR GetChannelAuthorEmail();
INT SetChannelAuthorEmail(LPCWSTR lpszChannelAuthorEmail);

char* ipworks_atom_getchannelauthoremail(void* lpObj);
int ipworks_atom_setchannelauthoremail(void* lpObj, const char* lpszChannelAuthorEmail);

QString GetChannelAuthorEmail();
int SetChannelAuthorEmail(QString qsChannelAuthorEmail);

Default Value

""

Remarks

This property contains the email address of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorName Property (Atom Class)

This property contains the name of the author.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelAuthorName();
int SetChannelAuthorName(const char* lpszChannelAuthorName);

Unicode (Windows)
LPWSTR GetChannelAuthorName();
INT SetChannelAuthorName(LPCWSTR lpszChannelAuthorName);

char* ipworks_atom_getchannelauthorname(void* lpObj);
int ipworks_atom_setchannelauthorname(void* lpObj, const char* lpszChannelAuthorName);

QString GetChannelAuthorName();
int SetChannelAuthorName(QString qsChannelAuthorName);

Default Value

""

Remarks

This property contains the name of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorUri Property (Atom Class)

This property contains the uniform resource identifier (URI) of the author.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelAuthorUri();
int SetChannelAuthorUri(const char* lpszChannelAuthorUri);

Unicode (Windows)
LPWSTR GetChannelAuthorUri();
INT SetChannelAuthorUri(LPCWSTR lpszChannelAuthorUri);

char* ipworks_atom_getchannelauthoruri(void* lpObj);
int ipworks_atom_setchannelauthoruri(void* lpObj, const char* lpszChannelAuthorUri);

QString GetChannelAuthorUri();
int SetChannelAuthorUri(QString qsChannelAuthorUri);

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the author.

This property is not available at design time.

Data Type

String

ChannelCategoryLabel Property (Atom Class)

This property contains a textual description of the label for the category.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelCategoryLabel();
int SetChannelCategoryLabel(const char* lpszChannelCategoryLabel);

Unicode (Windows)
LPWSTR GetChannelCategoryLabel();
INT SetChannelCategoryLabel(LPCWSTR lpszChannelCategoryLabel);

char* ipworks_atom_getchannelcategorylabel(void* lpObj);
int ipworks_atom_setchannelcategorylabel(void* lpObj, const char* lpszChannelCategoryLabel);

QString GetChannelCategoryLabel();
int SetChannelCategoryLabel(QString qsChannelCategoryLabel);

Default Value

""

Remarks

This property contains a textual description of the label for the category.

This property is not available at design time.

Data Type

String

ChannelCategoryScheme Property (Atom Class)

This property identifies a categorization scheme.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelCategoryScheme();
int SetChannelCategoryScheme(const char* lpszChannelCategoryScheme);

Unicode (Windows)
LPWSTR GetChannelCategoryScheme();
INT SetChannelCategoryScheme(LPCWSTR lpszChannelCategoryScheme);

char* ipworks_atom_getchannelcategoryscheme(void* lpObj);
int ipworks_atom_setchannelcategoryscheme(void* lpObj, const char* lpszChannelCategoryScheme);

QString GetChannelCategoryScheme();
int SetChannelCategoryScheme(QString qsChannelCategoryScheme);

Default Value

""

Remarks

This property identifies a categorization scheme.

This property is not available at design time.

Data Type

String

ChannelCategoryTerm Property (Atom Class)

This property contains the category to which the entry or feed belongs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelCategoryTerm();
int SetChannelCategoryTerm(const char* lpszChannelCategoryTerm);

Unicode (Windows)
LPWSTR GetChannelCategoryTerm();
INT SetChannelCategoryTerm(LPCWSTR lpszChannelCategoryTerm);

char* ipworks_atom_getchannelcategoryterm(void* lpObj);
int ipworks_atom_setchannelcategoryterm(void* lpObj, const char* lpszChannelCategoryTerm);

QString GetChannelCategoryTerm();
int SetChannelCategoryTerm(QString qsChannelCategoryTerm);

Default Value

""

Remarks

This property contains the category to which the entry or feed belongs.

This property is not available at design time.

Data Type

String

ChannelContributorEmail Property (Atom Class)

This property contains the email address of the contributor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelContributorEmail();
int SetChannelContributorEmail(const char* lpszChannelContributorEmail);

Unicode (Windows)
LPWSTR GetChannelContributorEmail();
INT SetChannelContributorEmail(LPCWSTR lpszChannelContributorEmail);

char* ipworks_atom_getchannelcontributoremail(void* lpObj);
int ipworks_atom_setchannelcontributoremail(void* lpObj, const char* lpszChannelContributorEmail);

QString GetChannelContributorEmail();
int SetChannelContributorEmail(QString qsChannelContributorEmail);

Default Value

""

Remarks

This property contains the email address of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorName Property (Atom Class)

This property contains the name of the contributor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelContributorName();
int SetChannelContributorName(const char* lpszChannelContributorName);

Unicode (Windows)
LPWSTR GetChannelContributorName();
INT SetChannelContributorName(LPCWSTR lpszChannelContributorName);

char* ipworks_atom_getchannelcontributorname(void* lpObj);
int ipworks_atom_setchannelcontributorname(void* lpObj, const char* lpszChannelContributorName);

QString GetChannelContributorName();
int SetChannelContributorName(QString qsChannelContributorName);

Default Value

""

Remarks

This property contains the name of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorUri Property (Atom Class)

This property contains the uniform resource identifier (URI) of the contributor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelContributorUri();
int SetChannelContributorUri(const char* lpszChannelContributorUri);

Unicode (Windows)
LPWSTR GetChannelContributorUri();
INT SetChannelContributorUri(LPCWSTR lpszChannelContributorUri);

char* ipworks_atom_getchannelcontributoruri(void* lpObj);
int ipworks_atom_setchannelcontributoruri(void* lpObj, const char* lpszChannelContributorUri);

QString GetChannelContributorUri();
int SetChannelContributorUri(QString qsChannelContributorUri);

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

This property is not available at design time.

Data Type

String

ChannelGenerator Property (Atom Class)

This property identifies the generator of the 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_atom_getchannelgenerator(void* lpObj);
int ipworks_atom_setchannelgenerator(void* lpObj, const char* lpszChannelGenerator);

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

Default Value

""

Remarks

This property identifies the generator of the feed.

This property is not available at design time.

Data Type

String

ChannelIcon Property (Atom Class)

This property contains a reference to the image that represents this feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelIcon();
int SetChannelIcon(const char* lpszChannelIcon);

Unicode (Windows)
LPWSTR GetChannelIcon();
INT SetChannelIcon(LPCWSTR lpszChannelIcon);

char* ipworks_atom_getchannelicon(void* lpObj);
int ipworks_atom_setchannelicon(void* lpObj, const char* lpszChannelIcon);

QString GetChannelIcon();
int SetChannelIcon(QString qsChannelIcon);

Default Value

""

Remarks

This property contains a reference to the image that represents this feed.

This property is not available at design time.

Data Type

String

ChannelId Property (Atom Class)

The Id conveys a permanent, universally unique identifier for an entry or feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelId();
int SetChannelId(const char* lpszChannelId);

Unicode (Windows)
LPWSTR GetChannelId();
INT SetChannelId(LPCWSTR lpszChannelId);

char* ipworks_atom_getchannelid(void* lpObj);
int ipworks_atom_setchannelid(void* lpObj, const char* lpszChannelId);

QString GetChannelId();
int SetChannelId(QString qsChannelId);

Default Value

""

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.

Data Type

String

ChannelLinkHref Property (Atom Class)

This property contains the location of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLinkHref();
int SetChannelLinkHref(const char* lpszChannelLinkHref);

Unicode (Windows)
LPWSTR GetChannelLinkHref();
INT SetChannelLinkHref(LPCWSTR lpszChannelLinkHref);

char* ipworks_atom_getchannellinkhref(void* lpObj);
int ipworks_atom_setchannellinkhref(void* lpObj, const char* lpszChannelLinkHref);

QString GetChannelLinkHref();
int SetChannelLinkHref(QString qsChannelLinkHref);

Default Value

""

Remarks

This property contains the location of the link.

This property is not available at design time.

Data Type

String

ChannelLinkHrefLang Property (Atom Class)

This property contains the language of the content at the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLinkHrefLang();
int SetChannelLinkHrefLang(const char* lpszChannelLinkHrefLang);

Unicode (Windows)
LPWSTR GetChannelLinkHrefLang();
INT SetChannelLinkHrefLang(LPCWSTR lpszChannelLinkHrefLang);

char* ipworks_atom_getchannellinkhreflang(void* lpObj);
int ipworks_atom_setchannellinkhreflang(void* lpObj, const char* lpszChannelLinkHrefLang);

QString GetChannelLinkHrefLang();
int SetChannelLinkHrefLang(QString qsChannelLinkHrefLang);

Default Value

""

Remarks

This property contains the language of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLinkLength Property (Atom Class)

This property contains the length (in bytes) of the content at the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLinkLength();
int SetChannelLinkLength(const char* lpszChannelLinkLength);

Unicode (Windows)
LPWSTR GetChannelLinkLength();
INT SetChannelLinkLength(LPCWSTR lpszChannelLinkLength);

char* ipworks_atom_getchannellinklength(void* lpObj);
int ipworks_atom_setchannellinklength(void* lpObj, const char* lpszChannelLinkLength);

QString GetChannelLinkLength();
int SetChannelLinkLength(QString qsChannelLinkLength);

Default Value

""

Remarks

This property contains the length (in bytes) of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLinkRel Property (Atom Class)

This property indicates the relation of the linked content to the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLinkRel();
int SetChannelLinkRel(const char* lpszChannelLinkRel);

Unicode (Windows)
LPWSTR GetChannelLinkRel();
INT SetChannelLinkRel(LPCWSTR lpszChannelLinkRel);

char* ipworks_atom_getchannellinkrel(void* lpObj);
int ipworks_atom_setchannellinkrel(void* lpObj, const char* lpszChannelLinkRel);

QString GetChannelLinkRel();
int SetChannelLinkRel(QString qsChannelLinkRel);

Default Value

""

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

This property is not available at design time.

Data Type

String

ChannelLinkTitle Property (Atom Class)

This property contains the title of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLinkTitle();
int SetChannelLinkTitle(const char* lpszChannelLinkTitle);

Unicode (Windows)
LPWSTR GetChannelLinkTitle();
INT SetChannelLinkTitle(LPCWSTR lpszChannelLinkTitle);

char* ipworks_atom_getchannellinktitle(void* lpObj);
int ipworks_atom_setchannellinktitle(void* lpObj, const char* lpszChannelLinkTitle);

QString GetChannelLinkTitle();
int SetChannelLinkTitle(QString qsChannelLinkTitle);

Default Value

""

Remarks

This property contains the title of the link.

This property is not available at design time.

Data Type

String

ChannelLinkType Property (Atom Class)

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLinkType();
int SetChannelLinkType(const char* lpszChannelLinkType);

Unicode (Windows)
LPWSTR GetChannelLinkType();
INT SetChannelLinkType(LPCWSTR lpszChannelLinkType);

char* ipworks_atom_getchannellinktype(void* lpObj);
int ipworks_atom_setchannellinktype(void* lpObj, const char* lpszChannelLinkType);

QString GetChannelLinkType();
int SetChannelLinkType(QString qsChannelLinkType);

Default Value

""

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

This property is not available at design time.

Data Type

String

ChannelLogo Property (Atom Class)

This property contains the logo for an image that represents the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelLogo();
int SetChannelLogo(const char* lpszChannelLogo);

Unicode (Windows)
LPWSTR GetChannelLogo();
INT SetChannelLogo(LPCWSTR lpszChannelLogo);

char* ipworks_atom_getchannellogo(void* lpObj);
int ipworks_atom_setchannellogo(void* lpObj, const char* lpszChannelLogo);

QString GetChannelLogo();
int SetChannelLogo(QString qsChannelLogo);

Default Value

""

Remarks

This property contains the logo for an image that represents the feed.

This property is not available at design time.

Data Type

String

ChannelRights Property (Atom Class)

This property contains information about the rights of the given feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelRights();
int SetChannelRights(const char* lpszChannelRights);

Unicode (Windows)
LPWSTR GetChannelRights();
INT SetChannelRights(LPCWSTR lpszChannelRights);

char* ipworks_atom_getchannelrights(void* lpObj);
int ipworks_atom_setchannelrights(void* lpObj, const char* lpszChannelRights);

QString GetChannelRights();
int SetChannelRights(QString qsChannelRights);

Default Value

""

Remarks

This property contains information about the rights of the given feed.

This property is not available at design time.

Data Type

String

ChannelRightsTextType Property (Atom Class)

This property contains the text type of the rights of the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChannelRightsTextType();
int SetChannelRightsTextType(int iChannelRightsTextType);

Unicode (Windows)
INT GetChannelRightsTextType();
INT SetChannelRightsTextType(INT iChannelRightsTextType);

TT_TEXT(0), 
TT_HTML(1), 
TT_XHTML(2)

int ipworks_atom_getchannelrightstexttype(void* lpObj);
int ipworks_atom_setchannelrightstexttype(void* lpObj, int iChannelRightsTextType);

int GetChannelRightsTextType();
int SetChannelRightsTextType(int iChannelRightsTextType);

Default Value

0

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelSubtitle Property (Atom Class)

This property contains a short description of the Atom feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelSubtitle();
int SetChannelSubtitle(const char* lpszChannelSubtitle);

Unicode (Windows)
LPWSTR GetChannelSubtitle();
INT SetChannelSubtitle(LPCWSTR lpszChannelSubtitle);

char* ipworks_atom_getchannelsubtitle(void* lpObj);
int ipworks_atom_setchannelsubtitle(void* lpObj, const char* lpszChannelSubtitle);

QString GetChannelSubtitle();
int SetChannelSubtitle(QString qsChannelSubtitle);

Default Value

""

Remarks

This property contains a short description of the Atom feed.

Data Type

String

ChannelSubtitleTextType Property (Atom Class)

This property contains the text type of the subtitle of the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChannelSubtitleTextType();
int SetChannelSubtitleTextType(int iChannelSubtitleTextType);

Unicode (Windows)
INT GetChannelSubtitleTextType();
INT SetChannelSubtitleTextType(INT iChannelSubtitleTextType);

TT_TEXT(0), 
TT_HTML(1), 
TT_XHTML(2)

int ipworks_atom_getchannelsubtitletexttype(void* lpObj);
int ipworks_atom_setchannelsubtitletexttype(void* lpObj, int iChannelSubtitleTextType);

int GetChannelSubtitleTextType();
int SetChannelSubtitleTextType(int iChannelSubtitleTextType);

Default Value

0

Remarks

This property contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelTitle Property (Atom Class)

This property contains the title of the current Atom feed.

Syntax

• C++
• C
• Qt

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

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

char* ipworks_atom_getchanneltitle(void* lpObj);
int ipworks_atom_setchanneltitle(void* lpObj, const char* lpszChannelTitle);

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

Default Value

""

Remarks

This property contains the title of the current Atom feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

Data Type

String

ChannelTitleTextType Property (Atom Class)

This property contains the text type of the title of the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChannelTitleTextType();
int SetChannelTitleTextType(int iChannelTitleTextType);

Unicode (Windows)
INT GetChannelTitleTextType();
INT SetChannelTitleTextType(INT iChannelTitleTextType);

TT_TEXT(0), 
TT_HTML(1), 
TT_XHTML(2)

int ipworks_atom_getchanneltitletexttype(void* lpObj);
int ipworks_atom_setchanneltitletexttype(void* lpObj, int iChannelTitleTextType);

int GetChannelTitleTextType();
int SetChannelTitleTextType(int iChannelTitleTextType);

Default Value

0

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

Data Type

Integer

ChannelUpdated Property (Atom Class)

This property contains the date and time that the feed was updated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelUpdated();
int SetChannelUpdated(const char* lpszChannelUpdated);

Unicode (Windows)
LPWSTR GetChannelUpdated();
INT SetChannelUpdated(LPCWSTR lpszChannelUpdated);

char* ipworks_atom_getchannelupdated(void* lpObj);
int ipworks_atom_setchannelupdated(void* lpObj, const char* lpszChannelUpdated);

QString GetChannelUpdated();
int SetChannelUpdated(QString qsChannelUpdated);

Default Value

""

Remarks

This property contains the date and time that the feed was updated.

Data Type

String

Connected Property (Atom 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_atom_getconnected(void* lpObj);
int ipworks_atom_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

ContentType Property (Atom Class)

This is the content type for posts and puts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentType();
int SetContentType(const char* lpszContentType);

Unicode (Windows)
LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);

char* ipworks_atom_getcontenttype(void* lpObj);
int ipworks_atom_setcontenttype(void* lpObj, const char* lpszContentType);

QString GetContentType();
int SetContentType(QString qsContentType);

Default Value

"application/atom+xml"

Remarks

If this property contains a nonempty string, a Content-Type HTTP request header is added to the request. The purpose of the header is to show the contents of the data during a PostResource or PutResource to the server.

This property is not available at design time.

Data Type

String

CookieCount Property (Atom 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_atom_getcookiecount(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_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 (Atom 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_atom_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 (Atom 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_atom_getcookiename(void* lpObj, int cookieindex);
int ipworks_atom_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 (Atom 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_atom_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 (Atom 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_atom_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 (Atom 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_atom_getcookievalue(void* lpObj, int cookieindex);
int ipworks_atom_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

EntryCount Property (Atom Class)

The number of records in the Entry arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryCount();
int SetEntryCount(int iEntryCount);

Unicode (Windows)
INT GetEntryCount();
INT SetEntryCount(INT iEntryCount);

int ipworks_atom_getentrycount(void* lpObj);
int ipworks_atom_setentrycount(void* lpObj, int iEntryCount);

int GetEntryCount();
int SetEntryCount(int iEntryCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• EntryAuthorEmail
• EntryAuthorName
• EntryAuthorUri
• EntryCategoryLabel
• EntryCategoryScheme
• EntryCategoryTerm
• EntryContent
• EntryContentTextType
• EntryContributorEmail
• EntryContributorName
• EntryContributorUri
• EntryCopyright
• EntryCreated
• EntryId
• EntryIssued
• EntryLinkHref
• EntryLinkHrefLang
• EntryLinkLength
• EntryLinkRel
• EntryLinkTitle
• EntryLinkType
• EntryModified
• EntryPublished
• EntryRights
• EntryRightsTextType
• EntrySource
• EntrySummary
• EntrySummaryTextType
• EntryTitle
• EntryTitleTextType
• EntryUpdated
• EntryXML

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

This property is not available at design time.

Data Type

Integer

EntryAuthorEmail Property (Atom Class)

This property contains the email address of the author.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryAuthorEmail(int iEntryIndex);
int SetEntryAuthorEmail(int iEntryIndex, const char* lpszEntryAuthorEmail);

Unicode (Windows)
LPWSTR GetEntryAuthorEmail(INT iEntryIndex);
INT SetEntryAuthorEmail(INT iEntryIndex, LPCWSTR lpszEntryAuthorEmail);

char* ipworks_atom_getentryauthoremail(void* lpObj, int entryindex);
int ipworks_atom_setentryauthoremail(void* lpObj, int entryindex, const char* lpszEntryAuthorEmail);

QString GetEntryAuthorEmail(int iEntryIndex);
int SetEntryAuthorEmail(int iEntryIndex, QString qsEntryAuthorEmail);

Default Value

""

Remarks

This property contains the email address of the author.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryAuthorName Property (Atom Class)

This property contains the name of the author.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryAuthorName(int iEntryIndex);
int SetEntryAuthorName(int iEntryIndex, const char* lpszEntryAuthorName);

Unicode (Windows)
LPWSTR GetEntryAuthorName(INT iEntryIndex);
INT SetEntryAuthorName(INT iEntryIndex, LPCWSTR lpszEntryAuthorName);

char* ipworks_atom_getentryauthorname(void* lpObj, int entryindex);
int ipworks_atom_setentryauthorname(void* lpObj, int entryindex, const char* lpszEntryAuthorName);

QString GetEntryAuthorName(int iEntryIndex);
int SetEntryAuthorName(int iEntryIndex, QString qsEntryAuthorName);

Default Value

""

Remarks

This property contains the name of the author.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryAuthorUri Property (Atom Class)

This property contains the uniform resource identifier (URI) of the author.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryAuthorUri(int iEntryIndex);
int SetEntryAuthorUri(int iEntryIndex, const char* lpszEntryAuthorUri);

Unicode (Windows)
LPWSTR GetEntryAuthorUri(INT iEntryIndex);
INT SetEntryAuthorUri(INT iEntryIndex, LPCWSTR lpszEntryAuthorUri);

char* ipworks_atom_getentryauthoruri(void* lpObj, int entryindex);
int ipworks_atom_setentryauthoruri(void* lpObj, int entryindex, const char* lpszEntryAuthorUri);

QString GetEntryAuthorUri(int iEntryIndex);
int SetEntryAuthorUri(int iEntryIndex, QString qsEntryAuthorUri);

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the author.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCategoryLabel Property (Atom Class)

This property contains a textual description of the label for the category.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryCategoryLabel(int iEntryIndex);
int SetEntryCategoryLabel(int iEntryIndex, const char* lpszEntryCategoryLabel);

Unicode (Windows)
LPWSTR GetEntryCategoryLabel(INT iEntryIndex);
INT SetEntryCategoryLabel(INT iEntryIndex, LPCWSTR lpszEntryCategoryLabel);

char* ipworks_atom_getentrycategorylabel(void* lpObj, int entryindex);
int ipworks_atom_setentrycategorylabel(void* lpObj, int entryindex, const char* lpszEntryCategoryLabel);

QString GetEntryCategoryLabel(int iEntryIndex);
int SetEntryCategoryLabel(int iEntryIndex, QString qsEntryCategoryLabel);

Default Value

""

Remarks

This property contains a textual description of the label for the category.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCategoryScheme Property (Atom Class)

This property identifies a categorization scheme.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryCategoryScheme(int iEntryIndex);
int SetEntryCategoryScheme(int iEntryIndex, const char* lpszEntryCategoryScheme);

Unicode (Windows)
LPWSTR GetEntryCategoryScheme(INT iEntryIndex);
INT SetEntryCategoryScheme(INT iEntryIndex, LPCWSTR lpszEntryCategoryScheme);

char* ipworks_atom_getentrycategoryscheme(void* lpObj, int entryindex);
int ipworks_atom_setentrycategoryscheme(void* lpObj, int entryindex, const char* lpszEntryCategoryScheme);

QString GetEntryCategoryScheme(int iEntryIndex);
int SetEntryCategoryScheme(int iEntryIndex, QString qsEntryCategoryScheme);

Default Value

""

Remarks

This property identifies a categorization scheme.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCategoryTerm Property (Atom Class)

This property contains the category to which the entry or feed belongs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryCategoryTerm(int iEntryIndex);
int SetEntryCategoryTerm(int iEntryIndex, const char* lpszEntryCategoryTerm);

Unicode (Windows)
LPWSTR GetEntryCategoryTerm(INT iEntryIndex);
INT SetEntryCategoryTerm(INT iEntryIndex, LPCWSTR lpszEntryCategoryTerm);

char* ipworks_atom_getentrycategoryterm(void* lpObj, int entryindex);
int ipworks_atom_setentrycategoryterm(void* lpObj, int entryindex, const char* lpszEntryCategoryTerm);

QString GetEntryCategoryTerm(int iEntryIndex);
int SetEntryCategoryTerm(int iEntryIndex, QString qsEntryCategoryTerm);

Default Value

""

Remarks

This property contains the category to which the entry or feed belongs.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContent Property (Atom Class)

This property contains the text contents of an Atom entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryContent(int iEntryIndex);
int SetEntryContent(int iEntryIndex, const char* lpszEntryContent);

Unicode (Windows)
LPWSTR GetEntryContent(INT iEntryIndex);
INT SetEntryContent(INT iEntryIndex, LPCWSTR lpszEntryContent);

char* ipworks_atom_getentrycontent(void* lpObj, int entryindex);
int ipworks_atom_setentrycontent(void* lpObj, int entryindex, const char* lpszEntryContent);

QString GetEntryContent(int iEntryIndex);
int SetEntryContent(int iEntryIndex, QString qsEntryContent);

Default Value

""

Remarks

This property contains the text contents of an Atom entry.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContentTextType Property (Atom Class)

This property contains the text type of the content of the entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryContentTextType(int iEntryIndex);
int SetEntryContentTextType(int iEntryIndex, int iEntryContentTextType);

Unicode (Windows)
INT GetEntryContentTextType(INT iEntryIndex);
INT SetEntryContentTextType(INT iEntryIndex, INT iEntryContentTextType);

TT_TEXT(0), 
TT_HTML(1), 
TT_XHTML(2)

int ipworks_atom_getentrycontenttexttype(void* lpObj, int entryindex);
int ipworks_atom_setentrycontenttexttype(void* lpObj, int entryindex, int iEntryContentTextType);

int GetEntryContentTextType(int iEntryIndex);
int SetEntryContentTextType(int iEntryIndex, int iEntryContentTextType);

Default Value

0

Remarks

This property contains the text type of the content of the entry. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntryContributorEmail Property (Atom Class)

This property contains the email address of the contributor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryContributorEmail(int iEntryIndex);
int SetEntryContributorEmail(int iEntryIndex, const char* lpszEntryContributorEmail);

Unicode (Windows)
LPWSTR GetEntryContributorEmail(INT iEntryIndex);
INT SetEntryContributorEmail(INT iEntryIndex, LPCWSTR lpszEntryContributorEmail);

char* ipworks_atom_getentrycontributoremail(void* lpObj, int entryindex);
int ipworks_atom_setentrycontributoremail(void* lpObj, int entryindex, const char* lpszEntryContributorEmail);

QString GetEntryContributorEmail(int iEntryIndex);
int SetEntryContributorEmail(int iEntryIndex, QString qsEntryContributorEmail);

Default Value

""

Remarks

This property contains the email address of the contributor.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContributorName Property (Atom Class)

This property contains the name of the contributor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryContributorName(int iEntryIndex);
int SetEntryContributorName(int iEntryIndex, const char* lpszEntryContributorName);

Unicode (Windows)
LPWSTR GetEntryContributorName(INT iEntryIndex);
INT SetEntryContributorName(INT iEntryIndex, LPCWSTR lpszEntryContributorName);

char* ipworks_atom_getentrycontributorname(void* lpObj, int entryindex);
int ipworks_atom_setentrycontributorname(void* lpObj, int entryindex, const char* lpszEntryContributorName);

QString GetEntryContributorName(int iEntryIndex);
int SetEntryContributorName(int iEntryIndex, QString qsEntryContributorName);

Default Value

""

Remarks

This property contains the name of the contributor.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryContributorUri Property (Atom Class)

This property contains the uniform resource identifier (URI) of the contributor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryContributorUri(int iEntryIndex);
int SetEntryContributorUri(int iEntryIndex, const char* lpszEntryContributorUri);

Unicode (Windows)
LPWSTR GetEntryContributorUri(INT iEntryIndex);
INT SetEntryContributorUri(INT iEntryIndex, LPCWSTR lpszEntryContributorUri);

char* ipworks_atom_getentrycontributoruri(void* lpObj, int entryindex);
int ipworks_atom_setentrycontributoruri(void* lpObj, int entryindex, const char* lpszEntryContributorUri);

QString GetEntryContributorUri(int iEntryIndex);
int SetEntryContributorUri(int iEntryIndex, QString qsEntryContributorUri);

Default Value

""

Remarks

This property contains the uniform resource identifier (URI) of the contributor.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCopyright Property (Atom Class)

This property includes a textual description of the copyright statement for the current ATOM feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryCopyright(int iEntryIndex);
int SetEntryCopyright(int iEntryIndex, const char* lpszEntryCopyright);

Unicode (Windows)
LPWSTR GetEntryCopyright(INT iEntryIndex);
INT SetEntryCopyright(INT iEntryIndex, LPCWSTR lpszEntryCopyright);

char* ipworks_atom_getentrycopyright(void* lpObj, int entryindex);
int ipworks_atom_setentrycopyright(void* lpObj, int entryindex, const char* lpszEntryCopyright);

QString GetEntryCopyright(int iEntryIndex);
int SetEntryCopyright(int iEntryIndex, QString qsEntryCopyright);

Default Value

""

Remarks

This property includes a textual description of the copyright statement for the current ATOM feed.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryCreated Property (Atom Class)

This property contains a date value that indicates the time that the current entry was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryCreated(int iEntryIndex);
int SetEntryCreated(int iEntryIndex, const char* lpszEntryCreated);

Unicode (Windows)
LPWSTR GetEntryCreated(INT iEntryIndex);
INT SetEntryCreated(INT iEntryIndex, LPCWSTR lpszEntryCreated);

char* ipworks_atom_getentrycreated(void* lpObj, int entryindex);
int ipworks_atom_setentrycreated(void* lpObj, int entryindex, const char* lpszEntryCreated);

QString GetEntryCreated(int iEntryIndex);
int SetEntryCreated(int iEntryIndex, QString qsEntryCreated);

Default Value

""

Remarks

This property contains a date value that indicates the time that the current entry was created.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryXML Property (Atom Class)

This property contains the full XML contents of the entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryXML(int iEntryIndex);
int SetEntryXML(int iEntryIndex, const char* lpszEntryXML);

Unicode (Windows)
LPWSTR GetEntryXML(INT iEntryIndex);
INT SetEntryXML(INT iEntryIndex, LPCWSTR lpszEntryXML);

char* ipworks_atom_getentryxml(void* lpObj, int entryindex);
int ipworks_atom_setentryxml(void* lpObj, int entryindex, const char* lpszEntryXML);

QString GetEntryXML(int iEntryIndex);
int SetEntryXML(int iEntryIndex, QString qsEntryXML);

Default Value

""

Remarks

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

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

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryId Property (Atom Class)

The Id conveys a permanent, universally unique identifier for an entry or feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryId(int iEntryIndex);
int SetEntryId(int iEntryIndex, const char* lpszEntryId);

Unicode (Windows)
LPWSTR GetEntryId(INT iEntryIndex);
INT SetEntryId(INT iEntryIndex, LPCWSTR lpszEntryId);

char* ipworks_atom_getentryid(void* lpObj, int entryindex);
int ipworks_atom_setentryid(void* lpObj, int entryindex, const char* lpszEntryId);

QString GetEntryId(int iEntryIndex);
int SetEntryId(int iEntryIndex, QString qsEntryId);

Default Value

""

Remarks

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an internationalized resource identifier (IRI) as defined by RFC 3987.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryIssued Property (Atom Class)

This property contains a date value that indicates the time that the current entry was issued.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryIssued(int iEntryIndex);
int SetEntryIssued(int iEntryIndex, const char* lpszEntryIssued);

Unicode (Windows)
LPWSTR GetEntryIssued(INT iEntryIndex);
INT SetEntryIssued(INT iEntryIndex, LPCWSTR lpszEntryIssued);

char* ipworks_atom_getentryissued(void* lpObj, int entryindex);
int ipworks_atom_setentryissued(void* lpObj, int entryindex, const char* lpszEntryIssued);

QString GetEntryIssued(int iEntryIndex);
int SetEntryIssued(int iEntryIndex, QString qsEntryIssued);

Default Value

""

Remarks

This property contains a date value that indicates the time that the current entry was issued.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkHref Property (Atom Class)

This property contains the location of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryLinkHref(int iEntryIndex);
int SetEntryLinkHref(int iEntryIndex, const char* lpszEntryLinkHref);

Unicode (Windows)
LPWSTR GetEntryLinkHref(INT iEntryIndex);
INT SetEntryLinkHref(INT iEntryIndex, LPCWSTR lpszEntryLinkHref);

char* ipworks_atom_getentrylinkhref(void* lpObj, int entryindex);
int ipworks_atom_setentrylinkhref(void* lpObj, int entryindex, const char* lpszEntryLinkHref);

QString GetEntryLinkHref(int iEntryIndex);
int SetEntryLinkHref(int iEntryIndex, QString qsEntryLinkHref);

Default Value

""

Remarks

This property contains the location of the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkHrefLang Property (Atom Class)

This property contains the language of the content at the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryLinkHrefLang(int iEntryIndex);
int SetEntryLinkHrefLang(int iEntryIndex, const char* lpszEntryLinkHrefLang);

Unicode (Windows)
LPWSTR GetEntryLinkHrefLang(INT iEntryIndex);
INT SetEntryLinkHrefLang(INT iEntryIndex, LPCWSTR lpszEntryLinkHrefLang);

char* ipworks_atom_getentrylinkhreflang(void* lpObj, int entryindex);
int ipworks_atom_setentrylinkhreflang(void* lpObj, int entryindex, const char* lpszEntryLinkHrefLang);

QString GetEntryLinkHrefLang(int iEntryIndex);
int SetEntryLinkHrefLang(int iEntryIndex, QString qsEntryLinkHrefLang);

Default Value

""

Remarks

This property contains the language of the content at the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkLength Property (Atom Class)

This property contains the length (in bytes) of the content at the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryLinkLength(int iEntryIndex);
int SetEntryLinkLength(int iEntryIndex, const char* lpszEntryLinkLength);

Unicode (Windows)
LPWSTR GetEntryLinkLength(INT iEntryIndex);
INT SetEntryLinkLength(INT iEntryIndex, LPCWSTR lpszEntryLinkLength);

char* ipworks_atom_getentrylinklength(void* lpObj, int entryindex);
int ipworks_atom_setentrylinklength(void* lpObj, int entryindex, const char* lpszEntryLinkLength);

QString GetEntryLinkLength(int iEntryIndex);
int SetEntryLinkLength(int iEntryIndex, QString qsEntryLinkLength);

Default Value

""

Remarks

This property contains the length (in bytes) of the content at the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkRel Property (Atom Class)

This property indicates the relation of the linked content to the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryLinkRel(int iEntryIndex);
int SetEntryLinkRel(int iEntryIndex, const char* lpszEntryLinkRel);

Unicode (Windows)
LPWSTR GetEntryLinkRel(INT iEntryIndex);
INT SetEntryLinkRel(INT iEntryIndex, LPCWSTR lpszEntryLinkRel);

char* ipworks_atom_getentrylinkrel(void* lpObj, int entryindex);
int ipworks_atom_setentrylinkrel(void* lpObj, int entryindex, const char* lpszEntryLinkRel);

QString GetEntryLinkRel(int iEntryIndex);
int SetEntryLinkRel(int iEntryIndex, QString qsEntryLinkRel);

Default Value

""

Remarks

This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

• alternate
• related
• self
• enclosure
• via

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkTitle Property (Atom Class)

This property contains the title of the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryLinkTitle(int iEntryIndex);
int SetEntryLinkTitle(int iEntryIndex, const char* lpszEntryLinkTitle);

Unicode (Windows)
LPWSTR GetEntryLinkTitle(INT iEntryIndex);
INT SetEntryLinkTitle(INT iEntryIndex, LPCWSTR lpszEntryLinkTitle);

char* ipworks_atom_getentrylinktitle(void* lpObj, int entryindex);
int ipworks_atom_setentrylinktitle(void* lpObj, int entryindex, const char* lpszEntryLinkTitle);

QString GetEntryLinkTitle(int iEntryIndex);
int SetEntryLinkTitle(int iEntryIndex, QString qsEntryLinkTitle);

Default Value

""

Remarks

This property contains the title of the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryLinkType Property (Atom Class)

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryLinkType(int iEntryIndex);
int SetEntryLinkType(int iEntryIndex, const char* lpszEntryLinkType);

Unicode (Windows)
LPWSTR GetEntryLinkType(INT iEntryIndex);
INT SetEntryLinkType(INT iEntryIndex, LPCWSTR lpszEntryLinkType);

char* ipworks_atom_getentrylinktype(void* lpObj, int entryindex);
int ipworks_atom_setentrylinktype(void* lpObj, int entryindex, const char* lpszEntryLinkType);

QString GetEntryLinkType(int iEntryIndex);
int SetEntryLinkType(int iEntryIndex, QString qsEntryLinkType);

Default Value

""

Remarks

This property contains the multipurpose internet mail extension (MIME) type of the content at the link.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryModified Property (Atom Class)

This property contains a date value that indicates the time in which the current entry was last modified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryModified(int iEntryIndex);
int SetEntryModified(int iEntryIndex, const char* lpszEntryModified);

Unicode (Windows)
LPWSTR GetEntryModified(INT iEntryIndex);
INT SetEntryModified(INT iEntryIndex, LPCWSTR lpszEntryModified);

char* ipworks_atom_getentrymodified(void* lpObj, int entryindex);
int ipworks_atom_setentrymodified(void* lpObj, int entryindex, const char* lpszEntryModified);

QString GetEntryModified(int iEntryIndex);
int SetEntryModified(int iEntryIndex, QString qsEntryModified);

Default Value

""

Remarks

This property contains a date value that indicates the time in which the current entry was last modified.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryPublished Property (Atom Class)

This property contains the date that the entry was first created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryPublished(int iEntryIndex);
int SetEntryPublished(int iEntryIndex, const char* lpszEntryPublished);

Unicode (Windows)
LPWSTR GetEntryPublished(INT iEntryIndex);
INT SetEntryPublished(INT iEntryIndex, LPCWSTR lpszEntryPublished);

char* ipworks_atom_getentrypublished(void* lpObj, int entryindex);
int ipworks_atom_setentrypublished(void* lpObj, int entryindex, const char* lpszEntryPublished);

QString GetEntryPublished(int iEntryIndex);
int SetEntryPublished(int iEntryIndex, QString qsEntryPublished);

Default Value

""

Remarks

This property contains the date that the entry was first created.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryRights Property (Atom Class)

This property contains information about the rights of the given entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryRights(int iEntryIndex);
int SetEntryRights(int iEntryIndex, const char* lpszEntryRights);

Unicode (Windows)
LPWSTR GetEntryRights(INT iEntryIndex);
INT SetEntryRights(INT iEntryIndex, LPCWSTR lpszEntryRights);

char* ipworks_atom_getentryrights(void* lpObj, int entryindex);
int ipworks_atom_setentryrights(void* lpObj, int entryindex, const char* lpszEntryRights);

QString GetEntryRights(int iEntryIndex);
int SetEntryRights(int iEntryIndex, QString qsEntryRights);

Default Value

""

Remarks

This property contains information about the rights of the given entry.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryRightsTextType Property (Atom Class)

This property contains the text type of the rights of the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryRightsTextType(int iEntryIndex);
int SetEntryRightsTextType(int iEntryIndex, int iEntryRightsTextType);

Unicode (Windows)
INT GetEntryRightsTextType(INT iEntryIndex);
INT SetEntryRightsTextType(INT iEntryIndex, INT iEntryRightsTextType);

TT_TEXT(0), 
TT_HTML(1), 
TT_XHTML(2)

int ipworks_atom_getentryrightstexttype(void* lpObj, int entryindex);
int ipworks_atom_setentryrightstexttype(void* lpObj, int entryindex, int iEntryRightsTextType);

int GetEntryRightsTextType(int iEntryIndex);
int SetEntryRightsTextType(int iEntryIndex, int iEntryRightsTextType);

Default Value

0

Remarks

This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntrySource Property (Atom Class)

This property is used when an entry has been copied from one feed to another feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntrySource(int iEntryIndex);
int SetEntrySource(int iEntryIndex, const char* lpszEntrySource);

Unicode (Windows)
LPWSTR GetEntrySource(INT iEntryIndex);
INT SetEntrySource(INT iEntryIndex, LPCWSTR lpszEntrySource);

char* ipworks_atom_getentrysource(void* lpObj, int entryindex);
int ipworks_atom_setentrysource(void* lpObj, int entryindex, const char* lpszEntrySource);

QString GetEntrySource(int iEntryIndex);
int SetEntrySource(int iEntryIndex, QString qsEntrySource);

Default Value

""

Remarks

This property is used when an entry has been copied from one feed to another feed. It preserves all child elements of the feed other than the entries.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntrySummary Property (Atom Class)

This property contains a short textual description of the Atom entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntrySummary(int iEntryIndex);
int SetEntrySummary(int iEntryIndex, const char* lpszEntrySummary);

Unicode (Windows)
LPWSTR GetEntrySummary(INT iEntryIndex);
INT SetEntrySummary(INT iEntryIndex, LPCWSTR lpszEntrySummary);

char* ipworks_atom_getentrysummary(void* lpObj, int entryindex);
int ipworks_atom_setentrysummary(void* lpObj, int entryindex, const char* lpszEntrySummary);

QString GetEntrySummary(int iEntryIndex);
int SetEntrySummary(int iEntryIndex, QString qsEntrySummary);

Default Value

""

Remarks

This property contains a short textual description of the Atom entry.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntrySummaryTextType Property (Atom Class)

This property contains the text type of the summary of the entry.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntrySummaryTextType(int iEntryIndex);
int SetEntrySummaryTextType(int iEntryIndex, int iEntrySummaryTextType);

Unicode (Windows)
INT GetEntrySummaryTextType(INT iEntryIndex);
INT SetEntrySummaryTextType(INT iEntryIndex, INT iEntrySummaryTextType);

TT_TEXT(0), 
TT_HTML(1), 
TT_XHTML(2)

int ipworks_atom_getentrysummarytexttype(void* lpObj, int entryindex);
int ipworks_atom_setentrysummarytexttype(void* lpObj, int entryindex, int iEntrySummaryTextType);

int GetEntrySummaryTextType(int iEntryIndex);
int SetEntrySummaryTextType(int iEntryIndex, int iEntrySummaryTextType);

Default Value

0

Remarks

This property contains the text type of the summary of the entry. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntryTitle Property (Atom Class)

This property contains the title of the current Atom Feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryTitle(int iEntryIndex);
int SetEntryTitle(int iEntryIndex, const char* lpszEntryTitle);

Unicode (Windows)
LPWSTR GetEntryTitle(INT iEntryIndex);
INT SetEntryTitle(INT iEntryIndex, LPCWSTR lpszEntryTitle);

char* ipworks_atom_getentrytitle(void* lpObj, int entryindex);
int ipworks_atom_setentrytitle(void* lpObj, int entryindex, const char* lpszEntryTitle);

QString GetEntryTitle(int iEntryIndex);
int SetEntryTitle(int iEntryIndex, QString qsEntryTitle);

Default Value

""

Remarks

This property contains the title of the current Atom Feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

EntryTitleTextType Property (Atom Class)

This property contains the text type of the title of the feed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEntryTitleTextType(int iEntryIndex);
int SetEntryTitleTextType(int iEntryIndex, int iEntryTitleTextType);

Unicode (Windows)
INT GetEntryTitleTextType(INT iEntryIndex);
INT SetEntryTitleTextType(INT iEntryIndex, INT iEntryTitleTextType);

TT_TEXT(0), 
TT_HTML(1), 
TT_XHTML(2)

int ipworks_atom_getentrytitletexttype(void* lpObj, int entryindex);
int ipworks_atom_setentrytitletexttype(void* lpObj, int entryindex, int iEntryTitleTextType);

int GetEntryTitleTextType(int iEntryIndex);
int SetEntryTitleTextType(int iEntryIndex, int iEntryTitleTextType);

Default Value

0

Remarks

This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer

EntryUpdated Property (Atom Class)

This property contains the date and time that the feed was updated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEntryUpdated(int iEntryIndex);
int SetEntryUpdated(int iEntryIndex, const char* lpszEntryUpdated);

Unicode (Windows)
LPWSTR GetEntryUpdated(INT iEntryIndex);
INT SetEntryUpdated(INT iEntryIndex, LPCWSTR lpszEntryUpdated);

char* ipworks_atom_getentryupdated(void* lpObj, int entryindex);
int ipworks_atom_setentryupdated(void* lpObj, int entryindex, const char* lpszEntryUpdated);

QString GetEntryUpdated(int iEntryIndex);
int SetEntryUpdated(int iEntryIndex, QString qsEntryUpdated);

Default Value

""

Remarks

This property contains the date and time that the feed was updated.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (Atom 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_atom_getfirewallautodetect(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getfirewalltype(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getfirewallhost(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getfirewallpassword(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getfirewallport(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getfirewalluser(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getfollowredirects(void* lpObj);
int ipworks_atom_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 (Atom Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_atom_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 (Atom 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_atom_getifmodifiedsince(void* lpObj);
int ipworks_atom_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

LocalFile Property (Atom 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_atom_getlocalfile(void* lpObj);
wchar_t* ipworks_atom_getlocalfile_W(void* lpObj); // Windows only
int ipworks_atom_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_atom_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 (Atom 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_atom_getlocalhost(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getnamespacecount(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getnamespaceprefix(void* lpObj, int namespaceindex);
int ipworks_atom_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 (Atom 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_atom_getnamespaceuri(void* lpObj, int namespaceindex);
int ipworks_atom_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 (Atom 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_atom_getotherheaders(void* lpObj);
int ipworks_atom_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 (Atom Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int ipworks_atom_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 (Atom 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_atom_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 (Atom 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_atom_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 (Atom 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_atom_getpassword(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getproxyauthscheme(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getproxyautodetect(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getproxypassword(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getproxyport(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getproxyserver(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getproxyssl(void* lpObj);
int ipworks_atom_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 (Atom Class)

This property contains a user name, 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_atom_getproxyuser(void* lpObj);
int ipworks_atom_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

This property contains a user name, 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

Referer Property (Atom 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_atom_getreferer(void* lpObj);
int ipworks_atom_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

Slug Property (Atom Class)

A header added to the HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSlug();
int SetSlug(const char* lpszSlug);

Unicode (Windows)
LPWSTR GetSlug();
INT SetSlug(LPCWSTR lpszSlug);

char* ipworks_atom_getslug(void* lpObj);
int ipworks_atom_setslug(void* lpObj, const char* lpszSlug);

QString GetSlug();
int SetSlug(QString qsSlug);

Default Value

""

Remarks

This property requests that the server use the header's value as part of any URLs that it normally would generate when creating the Entry or Media resources. Some servers ignore this header.

Data Type

String

SSLAcceptServerCertEncoded Property (Atom 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_atom_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_atom_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 (Atom 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_atom_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_atom_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 (Atom 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_atom_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_atom_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 are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (Atom 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_atom_getsslcertstorepassword(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getsslcertstoretype(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_getsslcertsubject(void* lpObj);
int ipworks_atom_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 displayed below.

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

Data Type

String

SSLProvider Property (Atom 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_atom_getsslprovider(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_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 (Atom 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_atom_gettimeout(void* lpObj);
int ipworks_atom_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 (Atom 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_atom_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 (Atom 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);