NNTP Class

Properties   Methods   Events   Config Settings   Errors  

The NNTP Class is used to read, search, and post articles on Usenet news servers.

Syntax

NNTP

Remarks

The NNTP 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 NNTP Class implements a standard Usenet news reader as specified in RFC 977. It can be used to browse Usenet news groups and to read and post articles.

The CurrentGroup property sets the current newsgroup. From then on, news articles from that group can be read by setting the article number in CurrentArticle and then calling the appropriate method. Properties, such as ArticleCount, FirstArticle, and LastArticle, provide information about the current state.

The headers and text of the articles are received through the Header and Transfer events, respectively. Additionally, up to MaxLines from the article body are provided in the ArticleText property. The GroupOverview event returns information about a range of articles (OverviewRange) in CurrentGroup, and the GroupList event is used when listing newsgroup names. The PITrail event provides a trace of the interaction with the server.

The class supports posting of articles through the ArticleText and AttachedFile properties. The article text is specified in one or both of the above, and then the PostArticle method is called. Article headers are given in a series of properties, such as ArticleFrom, ArticleSubject, and Organization, that map directly to the Usenet article header with the same name.

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.

ArticleCount Property (NNTP Class)

This property includes the estimated number of articles in CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetArticleCount();

Unicode (Windows)
LONG64 GetArticleCount();

int64 ipworks_nntp_getarticlecount(void* lpObj);

qint64 GetArticleCount();

Default Value

0

Remarks

This property contains the estimated number of articles in CurrentGroup. The value of this property is 0 if there is no current group (CurrentGroup is ""). Otherwise, when CurrentGroup is set, it is the number of articles in the group as shown by the news server. For most news servers, this is an estimated value of the number of the articles, rather than the exact value.

This property is read-only.

Data Type

Long64

ArticleDate Property (NNTP Class)

This property includes the date of the current article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleDate();

Unicode (Windows)
LPWSTR GetArticleDate();

char* ipworks_nntp_getarticledate(void* lpObj);

QString GetArticleDate();

Default Value

""

Remarks

This property contains the date of the current article. If the class is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the date of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

ArticleFrom Property (NNTP Class)

This property includes the email address of the author (for posting articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleFrom();
int SetArticleFrom(const char* lpszArticleFrom);

Unicode (Windows)
LPWSTR GetArticleFrom();
INT SetArticleFrom(LPCWSTR lpszArticleFrom);

char* ipworks_nntp_getarticlefrom(void* lpObj);
int ipworks_nntp_setarticlefrom(void* lpObj, const char* lpszArticleFrom);

QString GetArticleFrom();
int SetArticleFrom(QString qsArticleFrom);

Default Value

""

Remarks

This property contains the email address of the author (for posting articles). The string in this property is posted with a From article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleHeaders Property (NNTP Class)

This property includes the full headers of the article as retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleHeaders();

Unicode (Windows)
LPWSTR GetArticleHeaders();

char* ipworks_nntp_getarticleheaders(void* lpObj);

QString GetArticleHeaders();

Default Value

""

Remarks

This property contains the full headers of the article as retrieved from the server. If the class is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full headers of the article as reported by the server.

The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

ArticleId Property (NNTP Class)

This property includes the message identifier of the current article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleId();

Unicode (Windows)
LPWSTR GetArticleId();

char* ipworks_nntp_getarticleid(void* lpObj);

QString GetArticleId();

Default Value

""

Remarks

This property contains the message identifier of the current article. If the class is not connected or the CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the message identifier of the article as reported by the server. The NewsServer is asked about the headers of the article only if the CurrentArticle property has changed. If the CurrentArticle has not changed, the class returns a cached value.

This property is read-only.

Data Type

String

GroupOverviewCount Property (NNTP Class)

The number of records in the GroupOverview arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGroupOverviewCount();

Unicode (Windows)
INT GetGroupOverviewCount();

int ipworks_nntp_getgroupoverviewcount(void* lpObj);

int GetGroupOverviewCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• GroupOverviewArticleLines
• GroupOverviewArticleNumber
• GroupOverviewArticleSize
• GroupOverviewDate
• GroupOverviewFrom
• GroupOverviewMessageId
• GroupOverviewOtherHeaders
• GroupOverviewReferences
• GroupOverviewSubject

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

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

Data Type

Integer

GroupOverviewArticleLines Property (NNTP Class)

This is the number of lines of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupOverviewArticleLines(int iGroupOverviewIndex);

Unicode (Windows)
LONG64 GetGroupOverviewArticleLines(INT iGroupOverviewIndex);

int64 ipworks_nntp_getgroupoverviewarticlelines(void* lpObj, int groupoverviewindex);

qint64 GetGroupOverviewArticleLines(int iGroupOverviewIndex);

Default Value

0

Remarks

This is the number of lines of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

Long64

GroupOverviewArticleNumber Property (NNTP Class)

This is the number of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupOverviewArticleNumber(int iGroupOverviewIndex);

Unicode (Windows)
LONG64 GetGroupOverviewArticleNumber(INT iGroupOverviewIndex);

int64 ipworks_nntp_getgroupoverviewarticlenumber(void* lpObj, int groupoverviewindex);

qint64 GetGroupOverviewArticleNumber(int iGroupOverviewIndex);

Default Value

0

Remarks

This is the number of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

Long64

GroupOverviewArticleSize Property (NNTP Class)

This is the size of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupOverviewArticleSize(int iGroupOverviewIndex);

Unicode (Windows)
LONG64 GetGroupOverviewArticleSize(INT iGroupOverviewIndex);

int64 ipworks_nntp_getgroupoverviewarticlesize(void* lpObj, int groupoverviewindex);

qint64 GetGroupOverviewArticleSize(int iGroupOverviewIndex);

Default Value

0

Remarks

This is the size of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

Long64

GroupOverviewDate Property (NNTP Class)

This is the date of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewDate(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewDate(INT iGroupOverviewIndex);

char* ipworks_nntp_getgroupoverviewdate(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewDate(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the date of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewFrom Property (NNTP Class)

This is the sender of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewFrom(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewFrom(INT iGroupOverviewIndex);

char* ipworks_nntp_getgroupoverviewfrom(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewFrom(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the sender of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewMessageId Property (NNTP Class)

This is the unique message Id of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewMessageId(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewMessageId(INT iGroupOverviewIndex);

char* ipworks_nntp_getgroupoverviewmessageid(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewMessageId(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the unique message Id of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewOtherHeaders Property (NNTP Class)

This is the remaining headers of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewOtherHeaders(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewOtherHeaders(INT iGroupOverviewIndex);

char* ipworks_nntp_getgroupoverviewotherheaders(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewOtherHeaders(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the remaining headers of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewReferences Property (NNTP Class)

This is the references of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewReferences(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewReferences(INT iGroupOverviewIndex);

char* ipworks_nntp_getgroupoverviewreferences(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewReferences(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the references of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

GroupOverviewSubject Property (NNTP Class)

This is the subject of an article in a newsgroup overview.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupOverviewSubject(int iGroupOverviewIndex);

Unicode (Windows)
LPWSTR GetGroupOverviewSubject(INT iGroupOverviewIndex);

char* ipworks_nntp_getgroupoverviewsubject(void* lpObj, int groupoverviewindex);

QString GetGroupOverviewSubject(int iGroupOverviewIndex);

Default Value

""

Remarks

This is the subject of an article in a newsgroup overview.

The GroupOverviewIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupOverviewCount property.

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

Data Type

String

ArticleReferences Property (NNTP Class)

This property includes articles to which the posted article follows up.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleReferences();
int SetArticleReferences(const char* lpszArticleReferences);

Unicode (Windows)
LPWSTR GetArticleReferences();
INT SetArticleReferences(LPCWSTR lpszArticleReferences);

char* ipworks_nntp_getarticlereferences(void* lpObj);
int ipworks_nntp_setarticlereferences(void* lpObj, const char* lpszArticleReferences);

QString GetArticleReferences();
int SetArticleReferences(QString qsArticleReferences);

Default Value

""

Remarks

This property contains articles to which the posted article follows up. If this property contains a nonempty string, a References article header is created for the article. This header shows the article identifiers for the posted article to which it refers.

The references must be separated by space characters.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleReplyTo Property (NNTP Class)

This property includes the address to reply to (for posting articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleReplyTo();
int SetArticleReplyTo(const char* lpszArticleReplyTo);

Unicode (Windows)
LPWSTR GetArticleReplyTo();
INT SetArticleReplyTo(LPCWSTR lpszArticleReplyTo);

char* ipworks_nntp_getarticlereplyto(void* lpObj);
int ipworks_nntp_setarticlereplyto(void* lpObj, const char* lpszArticleReplyTo);

QString GetArticleReplyTo();
int SetArticleReplyTo(QString qsArticleReplyTo);

Default Value

""

Remarks

This property contains the address to reply to (for posting articles). If this property contains a nonempty string, a Reply-To article header is created for the article. This header shows the address to use for replies, which is useful if this address is different from the one in ArticleFrom.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleSubject Property (NNTP Class)

This property includes the article subject (for posted articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleSubject();
int SetArticleSubject(const char* lpszArticleSubject);

Unicode (Windows)
LPWSTR GetArticleSubject();
INT SetArticleSubject(LPCWSTR lpszArticleSubject);

char* ipworks_nntp_getarticlesubject(void* lpObj);
int ipworks_nntp_setarticlesubject(void* lpObj, const char* lpszArticleSubject);

QString GetArticleSubject();
int SetArticleSubject(QString qsArticleSubject);

Default Value

""

Remarks

The string in this property is posted with a Subject article header to the news server.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

ArticleText Property (NNTP Class)

This property includes the full text of the article (without the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArticleText();
int SetArticleText(const char* lpszArticleText);

Unicode (Windows)
LPWSTR GetArticleText();
INT SetArticleText(LPCWSTR lpszArticleText);

char* ipworks_nntp_getarticletext(void* lpObj);
int ipworks_nntp_setarticletext(void* lpObj, const char* lpszArticleText);

QString GetArticleText();
int SetArticleText(QString qsArticleText);

Default Value

""

Remarks

This property contains the full text of the article (without the headers). If the class is not connected or CurrentArticle is empty, the value of this property is an empty string. Otherwise, it contains the full text of the article as reported by the server.

The NewsServer is asked about the text of the article only if the CurrentArticle property has changed. If CurrentArticle has not changed, the class returns a cached value.

When posting articles, this property contains the full text of the article to post.

It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the article lines must contain 7-bit characters so that the article can be successfully transferred through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another "." as specified in RFC 977. The article text is unescaped by the news server, so the process is fully transparent.

This property is not available at design time.

Data Type

String

AttachedFile Property (NNTP Class)

This property includes a filename for which the contents will be appended to the ArticleText when posting articles.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachedFile();
int SetAttachedFile(const char* lpszAttachedFile);

Unicode (Windows)
LPWSTR GetAttachedFile();
INT SetAttachedFile(LPCWSTR lpszAttachedFile);

char* ipworks_nntp_getattachedfile(void* lpObj);
int ipworks_nntp_setattachedfile(void* lpObj, const char* lpszAttachedFile);

QString GetAttachedFile();
int SetAttachedFile(QString qsAttachedFile);

Default Value

""

Remarks

The content of this property is appended to the text in ArticleText (if any) and sent to the news server. This property is useful for posting arbitrarily large articles or sending MIME attachments.

It is advisable that the text contained in the file be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\r\n") . The text in the message lines must contain only 7-bit characters so that the message may be sent successfully through the various Usenet news servers on the Internet.

The class automatically escapes lines that start with a "." by adding another as specified in RFC 822. The article text is unescaped by the news server, so the process is fully transparent.

This property is not available at design time.

Data Type

String

CheckDate Property (NNTP Class)

This property includes the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckDate();
int SetCheckDate(const char* lpszCheckDate);

Unicode (Windows)
LPWSTR GetCheckDate();
INT SetCheckDate(LPCWSTR lpszCheckDate);

char* ipworks_nntp_getcheckdate(void* lpObj);
int ipworks_nntp_setcheckdate(void* lpObj, const char* lpszCheckDate);

QString GetCheckDate();
int SetCheckDate(QString qsCheckDate);

Default Value

"000101 000000"

Remarks

This property contains the date (format YYMMDD HHMMSS) to check for the creation of new groups. If the group was created after the date specified, it is considered new. The value of this property is used as an argument for the ListNewGroups method.

This property is not available at design time.

Data Type

String

Command Property (NNTP Class)

This property is used to send additional commands directly to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetCommand(const char* lpszCommand);

Unicode (Windows)
INT SetCommand(LPCWSTR lpszCommand);

int ipworks_nntp_setcommand(void* lpObj, const char* lpszCommand);

int SetCommand(QString qsCommand);

Default Value

""

Remarks

This property can be used to send additional commands directly to the server. Check the LastReply property or trap the PITrail events coming from the server to get the response.

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

Data Type

String

Connected Property (NNTP 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_nntp_getconnected(void* lpObj);
int ipworks_nntp_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

CurrentArticle Property (NNTP Class)

This property includes the number or message identifier of the current article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCurrentArticle();
int SetCurrentArticle(const char* lpszCurrentArticle);

Unicode (Windows)
LPWSTR GetCurrentArticle();
INT SetCurrentArticle(LPCWSTR lpszCurrentArticle);

char* ipworks_nntp_getcurrentarticle(void* lpObj);
int ipworks_nntp_setcurrentarticle(void* lpObj, const char* lpszCurrentArticle);

QString GetCurrentArticle();
int SetCurrentArticle(QString qsCurrentArticle);

Default Value

""

Remarks

This property specifies either a message identifier or an article number uniquely identifying a particular article. It is then used as an argument to methods such as FetchArticle.

Data Type

String

CurrentGroup Property (NNTP Class)

This property includes the name of the current group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCurrentGroup();
int SetCurrentGroup(const char* lpszCurrentGroup);

Unicode (Windows)
LPWSTR GetCurrentGroup();
INT SetCurrentGroup(LPCWSTR lpszCurrentGroup);

char* ipworks_nntp_getcurrentgroup(void* lpObj);
int ipworks_nntp_setcurrentgroup(void* lpObj, const char* lpszCurrentGroup);

QString GetCurrentGroup();
int SetCurrentGroup(QString qsCurrentGroup);

Default Value

""

Remarks

This property contains the name of the current group. When this property is set to a valid group name, the class sends a Network News Transfer Protocol (NNTP) GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle, LastArticle, and ArticleCount are set to the reported values for the group. This property is then used for all references to articles (until it is changed to another group).

Note: It is recommended to use the ChangeCurrentGroup method instead of setting this property.

Data Type

String

FirewallAutoDetect Property (NNTP 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_nntp_getfirewallautodetect(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_getfirewalltype(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_getfirewallhost(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_getfirewallpassword(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_getfirewallport(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_getfirewalluser(void* lpObj);
int ipworks_nntp_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

FirstArticle Property (NNTP Class)

This property includes the number of the first article in CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetFirstArticle();

Unicode (Windows)
LONG64 GetFirstArticle();

int64 ipworks_nntp_getfirstarticle(void* lpObj);

qint64 GetFirstArticle();

Default Value

0

Remarks

This property contains the number of the first article in CurrentGroup. The value of this property is zero if there is no current group (CurrentGroup is "").

This property is read-only.

Data Type

Long64

GroupListCount Property (NNTP Class)

The number of records in the GroupList arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGroupListCount();

Unicode (Windows)
INT GetGroupListCount();

int ipworks_nntp_getgrouplistcount(void* lpObj);

int GetGroupListCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• GroupListCanPost
• GroupListFirstArticle
• GroupListGroup
• GroupListLastArticle

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

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

Data Type

Integer

GroupListCanPost Property (NNTP Class)

This property indicates whether a group in a newsgroup listing allows postings or articles.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGroupListCanPost(int iGroupListIndex);

Unicode (Windows)
BOOL GetGroupListCanPost(INT iGroupListIndex);

int ipworks_nntp_getgrouplistcanpost(void* lpObj, int grouplistindex);

bool GetGroupListCanPost(int iGroupListIndex);

Default Value

FALSE

Remarks

This property indicates whether a group in a newsgroup listing allows postings or articles.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

Boolean

GroupListFirstArticle Property (NNTP Class)

This property shows the first available article in a newsgroup listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupListFirstArticle(int iGroupListIndex);

Unicode (Windows)
LONG64 GetGroupListFirstArticle(INT iGroupListIndex);

int64 ipworks_nntp_getgrouplistfirstarticle(void* lpObj, int grouplistindex);

qint64 GetGroupListFirstArticle(int iGroupListIndex);

Default Value

0

Remarks

This property shows the first available article in a newsgroup listing.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

Long64

GroupListGroup Property (NNTP Class)

This property shows the group name in a newsgroup listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGroupListGroup(int iGroupListIndex);

Unicode (Windows)
LPWSTR GetGroupListGroup(INT iGroupListIndex);

char* ipworks_nntp_getgrouplistgroup(void* lpObj, int grouplistindex);

QString GetGroupListGroup(int iGroupListIndex);

Default Value

""

Remarks

This property shows the group name in a newsgroup listing.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

String

GroupListLastArticle Property (NNTP Class)

This property shows the last available article in a newsgroup listing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetGroupListLastArticle(int iGroupListIndex);

Unicode (Windows)
LONG64 GetGroupListLastArticle(INT iGroupListIndex);

int64 ipworks_nntp_getgrouplistlastarticle(void* lpObj, int grouplistindex);

qint64 GetGroupListLastArticle(int iGroupListIndex);

Default Value

0

Remarks

This property shows the last available article in a newsgroup listing.

The GroupListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupListCount property.

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

Data Type

Long64

Idle Property (NNTP Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

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

LastArticle Property (NNTP Class)

This property includes the number of the last article in CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetLastArticle();

Unicode (Windows)
LONG64 GetLastArticle();

int64 ipworks_nntp_getlastarticle(void* lpObj);

qint64 GetLastArticle();

Default Value

0

Remarks

This property contains the number of the last article in CurrentGroup. The value of this property is zero if there is no current group (CurrentGroup is "").

This property is read-only.

Data Type

Long64

LastReply Property (NNTP Class)

The last reply from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLastReply();

Unicode (Windows)
LPWSTR GetLastReply();

char* ipworks_nntp_getlastreply(void* lpObj);

QString GetLastReply();

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.

This property is read-only.

Data Type

String

LocalFile Property (NNTP Class)

This property includes the path to a local file to download the article body. If the file exists, it is overwritten (optional).

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_nntp_getlocalfile(void* lpObj);
wchar_t* ipworks_nntp_getlocalfile_W(void* lpObj); // Windows only
int ipworks_nntp_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_nntp_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

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

Default Value

""

Remarks

This property is used when retrieving an article. If this property is empty, then the received data are provided through the parameters of the Transfer event.

Data Type

String

LocalHost Property (NNTP 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_nntp_getlocalhost(void* lpObj);
int ipworks_nntp_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

MaxLines Property (NNTP Class)

This property includes the maximum number of message lines aside from headers to retrieve.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMaxLines();
int SetMaxLines(int64 lMaxLines);

Unicode (Windows)
LONG64 GetMaxLines();
INT SetMaxLines(LONG64 lMaxLines);

int64 ipworks_nntp_getmaxlines(void* lpObj);
int ipworks_nntp_setmaxlines(void* lpObj, int64 lMaxLines);

qint64 GetMaxLines();
int SetMaxLines(qint64 lMaxLines);

Default Value

0

Remarks

This property is used to limit the number of text lines aside from headers retrieved for messages. This property is used in conjunction with the ArticleText property.

Note: Because of the Network News Transfer Protocol (NNTP) limitations, the full text of the article is always retrieved from the server, but only MaxLines will be stored in ArticleText.

The default value of the property is zero. In this case, the entire message will be retrieved, without interruptions.

This property is not available at design time.

Data Type

Long64

Newsgroups Property (NNTP Class)

This property includes a comma-separated list of newsgroups in which to post the article.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNewsgroups();
int SetNewsgroups(const char* lpszNewsgroups);

Unicode (Windows)
LPWSTR GetNewsgroups();
INT SetNewsgroups(LPCWSTR lpszNewsgroups);

char* ipworks_nntp_getnewsgroups(void* lpObj);
int ipworks_nntp_setnewsgroups(void* lpObj, const char* lpszNewsgroups);

QString GetNewsgroups();
int SetNewsgroups(QString qsNewsgroups);

Default Value

""

Remarks

The string in this property is posted with a Newsgroups article header to the news server. It specifies the list of groups where the article is posted (comma separated).

If this property contains "" (empty string), then the value of the CurrentGroup property is used to specify the target newsgroup for the posted article.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

NewsPort Property (NNTP Class)

This property includes the server port for the secure Network News Transfer Protocol (NNTP) (default 119).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNewsPort();
int SetNewsPort(int iNewsPort);

Unicode (Windows)
INT GetNewsPort();
INT SetNewsPort(INT iNewsPort);

int ipworks_nntp_getnewsport(void* lpObj);
int ipworks_nntp_setnewsport(void* lpObj, int iNewsPort);

int GetNewsPort();
int SetNewsPort(int iNewsPort);

Default Value

119

Remarks

For implicit Secure Sockets Layer (SSL), use port 563 (please refer to the SSLStartMode property for more information).

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

NewsServer Property (NNTP Class)

This property includes the name or address of a news server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNewsServer();
int SetNewsServer(const char* lpszNewsServer);

Unicode (Windows)
LPWSTR GetNewsServer();
INT SetNewsServer(LPCWSTR lpszNewsServer);

char* ipworks_nntp_getnewsserver(void* lpObj);
int ipworks_nntp_setnewsserver(void* lpObj, const char* lpszNewsServer);

QString GetNewsServer();
int SetNewsServer(QString qsNewsServer);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name for the news server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

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, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

Organization Property (NNTP Class)

This property includes the organization of the author (for posting articles).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrganization();
int SetOrganization(const char* lpszOrganization);

Unicode (Windows)
LPWSTR GetOrganization();
INT SetOrganization(LPCWSTR lpszOrganization);

char* ipworks_nntp_getorganization(void* lpObj);
int ipworks_nntp_setorganization(void* lpObj, const char* lpszOrganization);

QString GetOrganization();
int SetOrganization(QString qsOrganization);

Default Value

""

Remarks

This property contains the organization of the article's author. If this property contains a nonempty string, an Organization article header is created for the article. This header shows the organization of the author and is used for information purposes only.

If the resulting header is longer than MaxHeaderLength, then it is folded according to RFC 850 specifications.

This property is not available at design time.

Data Type

String

OtherHeaders Property (NNTP Class)

This property includes an RFC 850-compliant string consisting of extra headers (for posting articles).

Syntax

• C++
• C
• Qt

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

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

char* ipworks_nntp_getotherheaders(void* lpObj);
int ipworks_nntp_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

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

Default Value

""

Remarks

This property contains a string of headers to be appended to the message headers created from other properties like From and Subject.

The headers must be of the format "header: value" as specified in RFC 850. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, article posting might not be successful.

This property is useful for extending the functionality of the class. A good example is posting of MIME attachments.

Special Case: If this property starts with an empty line (e.g., carriage return line feed, CRLF), then the value of this property is used instead of the normally computed article headers.

This property is not available at design time.

Data Type

String

OverviewRange Property (NNTP Class)

This property includes the range for the GroupOverview method (first-last).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOverviewRange();
int SetOverviewRange(const char* lpszOverviewRange);

Unicode (Windows)
LPWSTR GetOverviewRange();
INT SetOverviewRange(LPCWSTR lpszOverviewRange);

char* ipworks_nntp_getoverviewrange(void* lpObj);
int ipworks_nntp_setoverviewrange(void* lpObj, const char* lpszOverviewRange);

QString GetOverviewRange();
int SetOverviewRange(QString qsOverviewRange);

Default Value

"-"

Remarks

This property specifies a range of articles for which to retrieve article overviews from the server. The format is 'first-last' where first is "" (empty string) or a positive number, and last is "" (empty string), a positive number, or the token end.

The default value of this property is '-', meaning 'all articles in the group'.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (NNTP Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int ipworks_nntp_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 (NNTP 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_nntp_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 (NNTP 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_nntp_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 (NNTP Class)

This property includes the logon password for the NewsServer .

Syntax

• C++
• C
• Qt

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

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

char* ipworks_nntp_getpassword(void* lpObj);
int ipworks_nntp_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

This property contains a logon password for the NewsServer. If this property is set to a nonempty string, then when connecting to the NewsServer an AUTHINFO PASS command is sent to provide authentication information for the user. This command is not part of the Network News Transfer Protocol (NNTP), but it is widely used by popular news servers.

Data Type

String

SearchHeader Property (NNTP Class)

This property includes a header for the GroupSearch method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchHeader();
int SetSearchHeader(const char* lpszSearchHeader);

Unicode (Windows)
LPWSTR GetSearchHeader();
INT SetSearchHeader(LPCWSTR lpszSearchHeader);

char* ipworks_nntp_getsearchheader(void* lpObj);
int ipworks_nntp_setsearchheader(void* lpObj, const char* lpszSearchHeader);

QString GetSearchHeader();
int SetSearchHeader(QString qsSearchHeader);

Default Value

""

Remarks

This property specifies the header to search for SearchPattern (e.g., Subject).

This property is not available at design time.

Data Type

String

SearchPattern Property (NNTP Class)

This property includes a search pattern for the GroupSearch method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchPattern();
int SetSearchPattern(const char* lpszSearchPattern);

Unicode (Windows)
LPWSTR GetSearchPattern();
INT SetSearchPattern(LPCWSTR lpszSearchPattern);

char* ipworks_nntp_getsearchpattern(void* lpObj);
int ipworks_nntp_setsearchpattern(void* lpObj, const char* lpszSearchPattern);

QString GetSearchPattern();
int SetSearchPattern(QString qsSearchPattern);

Default Value

""

Remarks

This property contains a search pattern for the GroupSearch method. The format of the pattern is the same as the patterns used by the UNIX Find command.

As an example, "* new *" will match all headers that contain the word "new".

This property is not available at design time.

Data Type

String

SearchRange Property (NNTP Class)

This property includes the range for the GroupSearch method (first-last).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchRange();
int SetSearchRange(const char* lpszSearchRange);

Unicode (Windows)
LPWSTR GetSearchRange();
INT SetSearchRange(LPCWSTR lpszSearchRange);

char* ipworks_nntp_getsearchrange(void* lpObj);
int ipworks_nntp_setsearchrange(void* lpObj, const char* lpszSearchRange);

QString GetSearchRange();
int SetSearchRange(QString qsSearchRange);

Default Value

"-"

Remarks

This property specifies a range of articles for which to do a search on the server. The format is First-Last where First is "" (empty string) or a positive number, and Last is "" (empty string), a positive number, or the token End.

The default value of the property is "-", meaning "search all articles in the group".

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (NNTP 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_nntp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_nntp_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 (NNTP 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_nntp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_nntp_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 (NNTP 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_nntp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_nntp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (NNTP 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_nntp_getsslcertstorepassword(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_getsslcertstoretype(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_getsslcertsubject(void* lpObj);
int ipworks_nntp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLEnabled Property (NNTP Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworks_nntp_getsslenabled(void* lpObj);
int ipworks_nntp_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (NNTP 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_nntp_getsslprovider(void* lpObj);
int ipworks_nntp_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 (NNTP 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_nntp_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

SSLStartMode Property (NNTP Class)

Determines how the class starts the SSL negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworks_nntp_getsslstartmode(void* lpObj);
int ipworks_nntp_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Timeout Property (NNTP 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_nntp_gettimeout(void* lpObj);
int ipworks_nntp_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

User Property (NNTP Class)

This property includes a user identifier to login as in the NewsServer .

Syntax

• C++
• C
• Qt

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

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

char* ipworks_nntp_getuser(void* lpObj);
int ipworks_nntp_setuser(void* lpObj, const char* lpszUser);

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

Default Value

""

Remarks

This property contains a user identifier to login as in the NewsServer. If this property is set to a nonempty string, then when connecting to the NewsServer an AUTHINFO USER command is sent to provide authentication information for the user. Although this command is not part of the Network News Transfer Protocol (NNTP), it is widely used by news servers for authentication purposes.

Data Type

String

ChangeCurrentGroup Method (NNTP Class)

This method changes the current group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeCurrentGroup(const char* lpszGroup);

Unicode (Windows)
INT ChangeCurrentGroup(LPCWSTR lpszGroup);

int ipworks_nntp_changecurrentgroup(void* lpObj, const char* lpszGroup);

int ChangeCurrentGroup(const QString& qsGroup);

Remarks

This method changes the current group. When calling this method, the class sends a Network News Transfer Protocol (NNTP) GROUP command to the NewsServer and enters the specified group. If the command is successful, FirstArticle, LastArticle, and ArticleCount are set to the reported values for the group.

Error Handling (C++)

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

Config Method (NNTP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

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

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

Connect Method (NNTP Class)

This method connects to the news server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworks_nntp_connect(void* lpObj);

int Connect();

Remarks

This method is used to connect to the news server. If the User and/or Password are set, then corresponding AUTHINFO commands are sent to the NewsServer as well.

Error Handling (C++)

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

Disconnect Method (NNTP Class)

This method disconnects from the news server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworks_nntp_disconnect(void* lpObj);

int Disconnect();

Remarks

This method is used to disconnect from the NewsServer. The class first attempts to send a QUIT command, and if that fails, the connection is broken.

Error Handling (C++)

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

DoEvents Method (NNTP Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_nntp_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

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

FetchArticle Method (NNTP Class)

This method gets the headers and body of an article specified in CurrentArticle .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchArticle();

Unicode (Windows)
INT FetchArticle();

int ipworks_nntp_fetcharticle(void* lpObj);

int FetchArticle();

Remarks

This method gets the headers and body of the article specified in CurrentArticle. The headers are delivered through the Header event, and the article body is delivered through the Transfer event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

FetchArticleBody Method (NNTP Class)

This method gets only the body of an article specified in CurrentArticle .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchArticleBody();

Unicode (Windows)
INT FetchArticleBody();

int ipworks_nntp_fetcharticlebody(void* lpObj);

int FetchArticleBody();

Remarks

This method gets only the body of the article specified in CurrentArticle. The body is delivered through the Transfer event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

FetchArticleHeaders Method (NNTP Class)

This method gets only the headers of an article specified in CurrentArticle .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FetchArticleHeaders();

Unicode (Windows)
INT FetchArticleHeaders();

int ipworks_nntp_fetcharticleheaders(void* lpObj);

int FetchArticleHeaders();

Remarks

This method gets only the headers of the article specified in CurrentArticle. The headers are delivered through the Header event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

GroupOverview Method (NNTP Class)

This method receives an overview for the articles in range OverviewRange in the CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GroupOverview();

Unicode (Windows)
INT GroupOverview();

int ipworks_nntp_groupoverview(void* lpObj);

int GroupOverview();

Remarks

This method receives an overview for the articles in range OverviewRange in the CurrentGroup. The overview data are delivered through the GroupOverview event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

GroupSearch Method (NNTP Class)

This method receives an overview for the articles in the range SearchRange in the CurrentGroup .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GroupSearch();

Unicode (Windows)
INT GroupSearch();

int ipworks_nntp_groupsearch(void* lpObj);

int GroupSearch();

Remarks

This method searches the current newsgroup for articles in the range SearchRange in the CurrentGroup, where SearchHeader matches SearchPattern. The results are delivered through the GroupSearch event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

Interrupt Method (NNTP Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_nntp_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

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

ListGroups Method (NNTP Class)

This method lists all newsgroups on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListGroups();

Unicode (Windows)
INT ListGroups();

int ipworks_nntp_listgroups(void* lpObj);

int ListGroups();

Remarks

This method asks the server to list all of its newsgroups. Use this method with caution as listing groups may take quite a long time over slow links. The group names and other information are returned via the GroupList event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

ListNewGroups Method (NNTP Class)

This method lists all newgroups on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListNewGroups();

Unicode (Windows)
INT ListNewGroups();

int ipworks_nntp_listnewgroups(void* lpObj);

int ListNewGroups();

Remarks

This method asks the server to list all of the newsgroups created since CheckDate. The group names (if any) and other information are returned via the GroupList event.

If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

LocalizeDate Method (NNTP Class)

This method converts a valid RFC 822 message date to a local date and time.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* LocalizeDate(const char* lpszDateTime);

Unicode (Windows)
LPWSTR LocalizeDate(LPCWSTR lpszDateTime);

char* ipworks_nntp_localizedate(void* lpObj, const char* lpszDateTime);

QString LocalizeDate(const QString& qsDateTime);

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

Error Handling (C++)

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

PostArticle Method (NNTP Class)

This method posts the current article and attached file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PostArticle();

Unicode (Windows)
INT PostArticle();

int ipworks_nntp_postarticle(void* lpObj);

int PostArticle();

Remarks

This method posts the current article and attached file (if any). If a connection to the NewsServer does not already exist, a new one is created.

Error Handling (C++)

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

Reset Method (NNTP Class)

This method resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_nntp_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

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

ResetHeaders Method (NNTP Class)

This method resets all of the article headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetHeaders();

Unicode (Windows)
INT ResetHeaders();

int ipworks_nntp_resetheaders(void* lpObj);

int ResetHeaders();

Remarks

This method resets all the article headers to "" (empty string). Use this method before posting a new article, so that headers from the previous article are not carried over to the next one.

Error Handling (C++)

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

SendCommand Method (NNTP Class)

Sends the exact command directly to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCommand(const char* lpszCommand);

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);

int ipworks_nntp_sendcommand(void* lpObj, const char* lpszCommand);

int SendCommand(const QString& qsCommand);

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method check the LastReply property and/or monitor the PITrail event to obtain the server's response.

Error Handling (C++)

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

ConnectionStatus Event (NNTP Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_NNTP_CONNECTIONSTATUS 1

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

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

  int StatusCode();

  const QString &Description();

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

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

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

Remarks

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

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

EndTransfer Event (NNTP Class)

This event is fired when the article text completes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_NNTP_ENDTRANSFER 2

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class NNTPEndTransferEventParams {
public:
  int Direction();

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

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

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

Remarks

The purpose of the EndTransfer event is twofold: (1) during article retrieval, it fires when the article body finishes transferring from the NewsServer to the local host; and (2) during article posting, it fires after the article body has been sent to the NewsServer.

If ArticleText is not empty, the EndTransfer event is fired when the ArticleText finishes transferring from the local host to the NewsServer. If ArticleText is empty, the event is not fired.

If a file is attached to the ArticleText through the AttachedFile property, then EndTransfer fires again when the file finishes transferring. Please see the description of the AttachedFile property for more information.

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

Error Event (NNTP Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_NNTP_ERROR 3

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

class NNTPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

GroupList Event (NNTP Class)

This event is fired while group data transfers (during group listings).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGroupList(NNTPGroupListEventParams *e);

typedef struct {
  const char *Group;
  int64 FirstArticle;
  int64 LastArticle;
  int CanPost;
  int reserved;
} NNTPGroupListEventParams;


Unicode (Windows)
virtual INT FireGroupList(NNTPGroupListEventParams *e);

typedef struct {
  LPCWSTR Group;
  LONG64 FirstArticle;
  LONG64 LastArticle;
  BOOL CanPost;
  INT reserved;
} NNTPGroupListEventParams;

#define EID_NNTP_GROUPLIST 4

virtual INT IPWORKS_CALL FireGroupList(LPSTR &lpszGroup, LONG64 &lFirstArticle, LONG64 &lLastArticle, BOOL &bCanPost);

class NNTPGroupListEventParams {
public:
  const QString &Group();

  qint64 FirstArticle();

  qint64 LastArticle();

  bool CanPost();

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FireGroupList(NNTPGroupListEventParams *e) {...}

Remarks

The GroupList event is fired for every group reported by the NewsServer when the ListGroups or ListNewGroups method is called.

The Group parameter shows the name of the group.

The FirstArticle and LastArticle parameters contain the article numbers for the first and last articles in the group.

The CanPost is True or False depending on whether article posting is allowed in the group specified by Group.

GroupOverview Event (NNTP Class)

This event is fired for each line of article overview data (during group overviews).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGroupOverview(NNTPGroupOverviewEventParams *e);

typedef struct {
  int64 ArticleNumber;
  const char *Subject;
  const char *From;
  const char *ArticleDate;
  const char *MessageId;
  const char *References;
  int64 ArticleSize;
  int64 ArticleLines;
  const char *OtherHeaders;
  int reserved;
} NNTPGroupOverviewEventParams;


Unicode (Windows)
virtual INT FireGroupOverview(NNTPGroupOverviewEventParams *e);

typedef struct {
  LONG64 ArticleNumber;
  LPCWSTR Subject;
  LPCWSTR From;
  LPCWSTR ArticleDate;
  LPCWSTR MessageId;
  LPCWSTR References;
  LONG64 ArticleSize;
  LONG64 ArticleLines;
  LPCWSTR OtherHeaders;
  INT reserved;
} NNTPGroupOverviewEventParams;

#define EID_NNTP_GROUPOVERVIEW 5

virtual INT IPWORKS_CALL FireGroupOverview(LONG64 &lArticleNumber, LPSTR &lpszSubject, LPSTR &lpszFrom, LPSTR &lpszArticleDate, LPSTR &lpszMessageId, LPSTR &lpszReferences, LONG64 &lArticleSize, LONG64 &lArticleLines, LPSTR &lpszOtherHeaders);

class NNTPGroupOverviewEventParams {
public:
  qint64 ArticleNumber();

  const QString &Subject();

  const QString &From();

  const QString &ArticleDate();

  const QString &MessageId();

  const QString &References();

  qint64 ArticleSize();

  qint64 ArticleLines();

  const QString &OtherHeaders();

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FireGroupOverview(NNTPGroupOverviewEventParams *e) {...}

Remarks

ArticleNumber contains the number of the article within the group.

Subject contains the subject of the article.

From contains the email address of the article author.

ArticleDate contains the date the article was posted.

MessageId contains the unique message Id for the article.

References contains the message Ids for the articles this article refers to (separated by spaces).

ArticleSize contains the size of the article in bytes.

ArticleLines contains the number of lines in the article.

OtherHeaders contains any other article headers that NewsServer chooses to display for the article.

GroupSearch Event (NNTP Class)

This event is fired for each line of group search data (during group searches).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGroupSearch(NNTPGroupSearchEventParams *e);

typedef struct {
  int64 ArticleNumber;
  const char *Header;
  int reserved;
} NNTPGroupSearchEventParams;


Unicode (Windows)
virtual INT FireGroupSearch(NNTPGroupSearchEventParams *e);

typedef struct {
  LONG64 ArticleNumber;
  LPCWSTR Header;
  INT reserved;
} NNTPGroupSearchEventParams;

#define EID_NNTP_GROUPSEARCH 6

virtual INT IPWORKS_CALL FireGroupSearch(LONG64 &lArticleNumber, LPSTR &lpszHeader);

class NNTPGroupSearchEventParams {
public:
  qint64 ArticleNumber();

  const QString &Header();

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FireGroupSearch(NNTPGroupSearchEventParams *e) {...}

Remarks

ArticleNumber contains the number of the article within the group.

Header contains the matching header.

Header Event (NNTP Class)

This event is fired for every article header being retrieved during article retrieval.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_NNTP_HEADER 7

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

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

  const QString &Value();

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

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

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

Remarks

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

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

PITrail Event (NNTP Class)

This event traces the commands sent to the news server, and the respective replies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(NNTPPITrailEventParams *e);

typedef struct {
  int Direction;
  const char *Message;
  int reserved;
} NNTPPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(NNTPPITrailEventParams *e);

typedef struct {
  INT Direction;
  LPCWSTR Message;
  INT reserved;
} NNTPPITrailEventParams;

#define EID_NNTP_PITRAIL 8

virtual INT IPWORKS_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);

class NNTPPITrailEventParams {
public:
  int Direction();

  const QString &Message();

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FirePITrail(NNTPPITrailEventParams *e) {...}

Remarks

The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line, except for group listings, group overviews, article header, and article body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

SSLServerAuthentication Event (NNTP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(NNTPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} NNTPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(NNTPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} NNTPSSLServerAuthenticationEventParams;

#define EID_NNTP_SSLSERVERAUTHENTICATION 9

virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class NNTPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FireSSLServerAuthentication(NNTPSSLServerAuthenticationEventParams *e) {...}

Remarks

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

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

SSLStatus Event (NNTP Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(NNTPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} NNTPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(NNTPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} NNTPSSLStatusEventParams;

#define EID_NNTP_SSLSTATUS 10

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

class NNTPSSLStatusEventParams {
public:
  const QString &Message();

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FireSSLStatus(NNTPSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (NNTP Class)

This event is fired when the article text starts transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(NNTPStartTransferEventParams *e);

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


Unicode (Windows)
virtual INT FireStartTransfer(NNTPStartTransferEventParams *e);

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

#define EID_NNTP_STARTTRANSFER 11

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);

class NNTPStartTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FireStartTransfer(NNTPStartTransferEventParams *e) {...}

Remarks

The purpose of the StartTransfer event is twofold: during article retrieval, it fires when the article body starts transferring from the NewsServer to the local host, and during article posting, it fires before the article body is sent to the NewsServer.

If ArticleText is not empty, the StartTransfer event is fired when the ArticleText starts transferring from the local host to the NewsServer. If ArticleText is empty, the event is not fired.

If a file is attached to the ArticleText via the AttachedFile property, then StartTransfer fires again when the file starts transferring. Please go to the description of the AttachedFile property for more information.

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

Transfer Event (NNTP Class)

This event is fired while the article text gets transferred (to or from the NewsServer ).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(NNTPTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int EOL;
  int reserved;
} NNTPTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(NNTPTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  BOOL EOL;
  INT reserved;
} NNTPTransferEventParams;

#define EID_NNTP_TRANSFER 12

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bEOL);

class NNTPTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  bool EOL();

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

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

// Or, subclass NNTP and override this emitter function.
virtual int FireTransfer(NNTPTransferEventParams *e) {...}

Remarks

One or more Transfer events are fired during article retrieval. The Text parameter contains the portion of article data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the article, including header bytes.

One or more Transfer events are also fired during article posting. Articles consist of ArticleText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of ArticleText and/or AttachedFile.

The Transfer event is fired for every line of the article. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

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

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

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

Config Settings (NNTP Class)

NNTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (NNTP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

NNTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors