Docs

IPWorks 2022 C++ Edition

Version 22.0 [Build 8171]

Atom Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

Atom

Remarks

The Atom class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The Atom Class implements a standard Atom client as defined by RFC 4287 (http://www.ietf.org/rfc/rfc4287) and includes the Atom publishing capabilities as defined by the "The Atom Publishing Protocol" (http://www.ietf.org/rfc/rfc5023).

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

The Atom Class supports all standard Atom properties and allows you to add your own through AddNamespace and the GetProperty and SetProperty methods.

Property List


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

AcceptA list of acceptable MIME types for the request.
AtomDataThis is the complete content of the Atom resource.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
ChannelAuthorEmailThis property contains the email address of the author.
ChannelAuthorNameThis property contains the name of the author.
ChannelAuthorUriThis property contains the uniform resource identifier (URI) of the author.
ChannelCategoryLabelThis property contains a textual description of the label for the category.
ChannelCategorySchemeThis property identifies a categorization scheme.
ChannelCategoryTermThis property contains the category to which the entry or feed belongs.
ChannelContributorEmailThis property contains the email address of the contributor.
ChannelContributorNameThis property contains the name of the contributor.
ChannelContributorUriThis property contains the uniform resource identifier (URI) of the contributor.
ChannelGeneratorThis property identifies the generator of the feed.
ChannelIconThis property contains a reference to the image that represents this feed.
ChannelIdThe Id conveys a permanent, universally unique identifier for an entry or feed.
ChannelLinkHrefThis property contains the location of the link.
ChannelLinkHrefLangThis property contains the language of the content at the link.
ChannelLinkLengthThis property contains the length (in bytes) of the content at the link.
ChannelLinkRelThis property indicates the relation of the linked content to the feed.
ChannelLinkTitleThis property contains the title of the link.
ChannelLinkTypeThis property contains the multipurpose internet mail extension (MIME) type of the content at the link.
ChannelLogoThis property contains the logo for an image that represents the feed.
ChannelRightsThis property contains information about the rights of the given feed.
ChannelRightsTextTypeThis property contains the text type of the rights of the feed.
ChannelSubtitleThis property contains a short description of the Atom feed.
ChannelSubtitleTextTypeThis property contains the text type of the subtitle of the feed.
ChannelTitleThis property contains the title of the current Atom feed.
ChannelTitleTextTypeThis property contains the text type of the title of the feed.
ChannelUpdatedThis property contains the date and time that the feed was updated.
ConnectedShows whether the class is connected.
ContentTypeThis is the content type for posts and puts.
CookieCountThe number of records in the Cookie arrays.
CookieDomainThe domain of a received cookie.
CookieExpirationThis property contains an expiration time for the cookie (if provided by the server).
CookieNameThe name of the cookie.
CookiePathThis property contains a path name to limit the cookie to (if provided by the server).
CookieSecureThis property contains the security flag of the received cookie.
CookieValueThis property contains the value of the cookie.
EntryCountThe number of records in the Entry arrays.
EntryAuthorEmailThis property contains the email address of the author.
EntryAuthorNameThis property contains the name of the author.
EntryAuthorUriThis property contains the uniform resource identifier (URI) of the author.
EntryCategoryLabelThis property contains a textual description of the label for the category.
EntryCategorySchemeThis property identifies a categorization scheme.
EntryCategoryTermThis property contains the category to which the entry or feed belongs.
EntryContentThis property contains the text contents of an Atom entry.
EntryContentTextTypeThis property contains the text type of the content of the entry.
EntryContributorEmailThis property contains the email address of the contributor.
EntryContributorNameThis property contains the name of the contributor.
EntryContributorUriThis property contains the uniform resource identifier (URI) of the contributor.
EntryCopyrightThis property includes a textual description of the copyright statement for the current ATOM feed.
EntryCreatedThis property contains a date value that indicates the time that the current entry was created.
EntryXMLThis property contains the full XML contents of the entry.
EntryIdThe Id conveys a permanent, universally unique identifier for an entry or feed.
EntryIssuedThis property contains a date value that indicates the time that the current entry was issued.
EntryLinkHrefThis property contains the location of the link.
EntryLinkHrefLangThis property contains the language of the content at the link.
EntryLinkLengthThis property contains the length (in bytes) of the content at the link.
EntryLinkRelThis property indicates the relation of the linked content to the feed.
EntryLinkTitleThis property contains the title of the link.
EntryLinkTypeThis property contains the multipurpose internet mail extension (MIME) type of the content at the link.
EntryModifiedThis property contains a date value that indicates the time in which the current entry was last modified.
EntryPublishedThis property contains the date that the entry was first created.
EntryRightsThis property contains information about the rights of the given entry.
EntryRightsTextTypeThis property contains the text type of the rights of the feed.
EntrySourceThis property is used when an entry has been copied from one feed to another feed.
EntrySummaryThis property contains a short textual description of the Atom entry.
EntrySummaryTextTypeThis property contains the text type of the summary of the entry.
EntryTitleThis property contains the title of the current Atom Feed.
EntryTitleTextTypeThis property contains the text type of the title of the feed.
EntryUpdatedThis property contains the date and time that the feed was updated.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the class.
IfModifiedSinceA date determining the maximum age of the desired document.
LocalFileThe path to a local file for downloading. If the file exists, it is overwritten.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NamespaceCountThe number of records in the Namespace arrays.
NamespacePrefixThe Prefix for the Namespace .
NamespaceURINamespace URI associated with the corresponding Prefix .
OtherHeadersOther headers as determined by the user (optional).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PasswordA password if authentication is to be used.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RefererReferer URL/document (optional).
SlugA header added to the HTTP request.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderTBD.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
TimeoutA timeout for the class.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum of bytes of data to be transferred.
TransferredHeadersThe full set of headers as received from the server.
UpdateEntryAuthorEmailThis property contains the email address of the author.
UpdateEntryAuthorNameThis property contains the name of the author.
UpdateEntryAuthorUriThis property contains the uniform resource identifier (URI) of the author.
UpdateEntryCategoryLabelThis property contains a textual description of the label for the category.
UpdateEntryCategorySchemeThis property identifies a categorization scheme.
UpdateEntryCategoryTermThis property contains the category to which the entry or feed belongs.
UpdateEntryContentThis property contains the text contents of an Atom entry.
UpdateEntryContentTextTypeThis property contains the text type of the content of the entry.
UpdateEntryContributorEmailThis property contains the email address of the contributor.
UpdateEntryContributorNameThis property contains the name of the contributor.
UpdateEntryContributorUriThis property contains the uniform resource identifier (URI) of the contributor.
UpdateEntryCopyrightThis property includes a textual description of the copyright statement for the current ATOM feed.
UpdateEntryCreatedThis property contains a date value that indicates the time that the current entry was created.
UpdateEntryXMLThis property contains the full XML contents of the entry.
UpdateEntryIdThe Id conveys a permanent, universally unique identifier for an entry or feed.
UpdateEntryIssuedThis property contains a date value that indicates the time that the current entry was issued.
UpdateEntryLinkHrefThis property contains the location of the link.
UpdateEntryLinkHrefLangThis property contains the language of the content at the link.
UpdateEntryLinkLengthThis property contains the length (in bytes) of the content at the link.
UpdateEntryLinkRelThis property indicates the relation of the linked content to the feed.
UpdateEntryLinkTitleThis property contains the title of the link.
UpdateEntryLinkTypeThis property contains the multipurpose internet mail extension (MIME) type of the content at the link.
UpdateEntryModifiedThis property contains a date value that indicates the time in which the current entry was last modified.
UpdateEntryPublishedThis property contains the date that the entry was first created.
UpdateEntryRightsThis property contains information about the rights of the given entry.
UpdateEntryRightsTextTypeThis property contains the text type of the rights of the feed.
UpdateEntrySourceThis property is used when an entry has been copied from one feed to another feed.
UpdateEntrySummaryThis property contains a short textual description of the Atom entry.
UpdateEntrySummaryTextTypeThis property contains the text type of the summary of the entry.
UpdateEntryTitleThis property contains the title of the current Atom Feed.
UpdateEntryTitleTextTypeThis property contains the text type of the title of the feed.
UpdateEntryUpdatedThis property contains the date and time that the feed was updated.
UpdateFileThis is a resource to be updated, deleted, or created.
UserA user name if authentication is to be used.

Method List


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

AddCookieAdds a cookie and the corresponding value to the outgoing request headers.
AddNamespaceThis method adds a namespace to the Namespaces properties.
ConfigSets or retrieves a configuration setting.
DeleteResourceThis method deletes the resource at the specified URL.
DoEventsProcesses events from the internal message queue.
GetFeedThis method fetches an Atom feed.
GetPropertyThis method fetches the value of a specific Atom feed element or attribute.
GetResourceThis method fetches a resource.
InterruptInterrupt the current method.
PostResourceThis method posts a resource to the specified URL.
PutThis method sends data to the HTTP server using the HTTP PUT method.
PutResourceThis method puts a resource to the specified URL.
ReadFileThis method loads an Atom file into the class.
ResetThis method resets all properties of the class.
SetPropertyThis method sets the value of a specific Atom feed property.
WriteFileThis method is used to write an Atom feed from the class.

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.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
EndTransferThis event fires when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
LogFires once for each log message.
RedirectFired when a redirection is received from the server.
SetCookieFired for every cookie set by the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferThis event fires when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13ProviderThe TLS 1.3 implementation to be used.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Accept Property (Atom Class)

A list of acceptable MIME types for the request.

Syntax

ANSI (Cross Platform)
char* GetAccept();
int SetAccept(const char* lpszAccept); Unicode (Windows) LPWSTR GetAccept();
INT SetAccept(LPCWSTR lpszAccept);
@property (nonatomic,readwrite,assign,getter=accept,setter=setAccept:) NSString* accept;

- (NSString*)accept;
- (void)setAccept:(NSString*)newAccept;
char* ipworks_atom_getaccept(void* lpObj);
int ipworks_atom_setaccept(void* lpObj, const char* lpszAccept);

Default Value

""

Remarks

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

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

Data Type

String

AtomData Property (Atom Class)

This is the complete content of the Atom resource.

Syntax

ANSI (Cross Platform)
int GetAtomData(char* &lpAtomData, int &lenAtomData);
int SetAtomData(const char* lpAtomData, int lenAtomData); Unicode (Windows) INT GetAtomData(LPSTR &lpAtomData, INT &lenAtomData);
INT SetAtomData(LPCSTR lpAtomData, INT lenAtomData);
@property (nonatomic,readwrite,assign,getter=atomData,setter=setAtomData:) NSString* atomData;

- (NSString*)atomData;
- (void)setAtomData:(NSString*)newAtomData;

@property (nonatomic,readwrite,assign,getter=atomDataB,setter=setAtomDataB:) NSData* atomDataB; - (NSData*)atomDataB; - (void)setAtomDataB:(NSData*)newAtomData;
int ipworks_atom_getatomdata(void* lpObj, char** lpAtomData, int* lenAtomData);
int ipworks_atom_setatomdata(void* lpObj, const char* lpAtomData, int lenAtomData);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

Binary String

Authorization Property (Atom Class)

The Authorization string to be sent to the server.

Syntax

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization); Unicode (Windows) LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);
@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization;

- (NSString*)authorization;
- (void)setAuthorization:(NSString*)newAuthorization;
char* ipworks_atom_getauthorization(void* lpObj);
int ipworks_atom_setauthorization(void* lpObj, const char* lpszAuthorization);

Default Value

""

Remarks

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

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

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

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

Data Type

String

AuthScheme Property (Atom Class)

The authentication scheme to use when server authorization is required.

Syntax

ANSI (Cross Platform)
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme); Unicode (Windows) INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5),
AUTH_OAUTH(6)
@property (nonatomic,readwrite,assign,getter=authScheme,setter=setAuthScheme:) int authScheme;

- (int)authScheme;
- (void)setAuthScheme:(int)newAuthScheme;

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5),
AUTH_OAUTH(6)
int ipworks_atom_getauthscheme(void* lpObj);
int ipworks_atom_setauthscheme(void* lpObj, int iAuthScheme);

Default Value

0

Remarks

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

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

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

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

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

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

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

Data Type

Integer

ChannelAuthorEmail Property (Atom Class)

This property contains the email address of the author.

Syntax

ANSI (Cross Platform)
char* GetChannelAuthorEmail();
int SetChannelAuthorEmail(const char* lpszChannelAuthorEmail); Unicode (Windows) LPWSTR GetChannelAuthorEmail();
INT SetChannelAuthorEmail(LPCWSTR lpszChannelAuthorEmail);
@property (nonatomic,readwrite,assign,getter=channelAuthorEmail,setter=setChannelAuthorEmail:) NSString* channelAuthorEmail;

- (NSString*)channelAuthorEmail;
- (void)setChannelAuthorEmail:(NSString*)newChannelAuthorEmail;
char* ipworks_atom_getchannelauthoremail(void* lpObj);
int ipworks_atom_setchannelauthoremail(void* lpObj, const char* lpszChannelAuthorEmail);

Default Value

""

Remarks

This property contains the email address of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorName Property (Atom Class)

This property contains the name of the author.

Syntax

ANSI (Cross Platform)
char* GetChannelAuthorName();
int SetChannelAuthorName(const char* lpszChannelAuthorName); Unicode (Windows) LPWSTR GetChannelAuthorName();
INT SetChannelAuthorName(LPCWSTR lpszChannelAuthorName);
@property (nonatomic,readwrite,assign,getter=channelAuthorName,setter=setChannelAuthorName:) NSString* channelAuthorName;

- (NSString*)channelAuthorName;
- (void)setChannelAuthorName:(NSString*)newChannelAuthorName;
char* ipworks_atom_getchannelauthorname(void* lpObj);
int ipworks_atom_setchannelauthorname(void* lpObj, const char* lpszChannelAuthorName);

Default Value

""

Remarks

This property contains the name of the author.

This property is not available at design time.

Data Type

String

ChannelAuthorUri Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelAuthorUri();
int SetChannelAuthorUri(const char* lpszChannelAuthorUri); Unicode (Windows) LPWSTR GetChannelAuthorUri();
INT SetChannelAuthorUri(LPCWSTR lpszChannelAuthorUri);
@property (nonatomic,readwrite,assign,getter=channelAuthorUri,setter=setChannelAuthorUri:) NSString* channelAuthorUri;

- (NSString*)channelAuthorUri;
- (void)setChannelAuthorUri:(NSString*)newChannelAuthorUri;
char* ipworks_atom_getchannelauthoruri(void* lpObj);
int ipworks_atom_setchannelauthoruri(void* lpObj, const char* lpszChannelAuthorUri);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelCategoryLabel Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelCategoryLabel();
int SetChannelCategoryLabel(const char* lpszChannelCategoryLabel); Unicode (Windows) LPWSTR GetChannelCategoryLabel();
INT SetChannelCategoryLabel(LPCWSTR lpszChannelCategoryLabel);
@property (nonatomic,readwrite,assign,getter=channelCategoryLabel,setter=setChannelCategoryLabel:) NSString* channelCategoryLabel;

- (NSString*)channelCategoryLabel;
- (void)setChannelCategoryLabel:(NSString*)newChannelCategoryLabel;
char* ipworks_atom_getchannelcategorylabel(void* lpObj);
int ipworks_atom_setchannelcategorylabel(void* lpObj, const char* lpszChannelCategoryLabel);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelCategoryScheme Property (Atom Class)

This property identifies a categorization scheme.

Syntax

ANSI (Cross Platform)
char* GetChannelCategoryScheme();
int SetChannelCategoryScheme(const char* lpszChannelCategoryScheme); Unicode (Windows) LPWSTR GetChannelCategoryScheme();
INT SetChannelCategoryScheme(LPCWSTR lpszChannelCategoryScheme);
@property (nonatomic,readwrite,assign,getter=channelCategoryScheme,setter=setChannelCategoryScheme:) NSString* channelCategoryScheme;

- (NSString*)channelCategoryScheme;
- (void)setChannelCategoryScheme:(NSString*)newChannelCategoryScheme;
char* ipworks_atom_getchannelcategoryscheme(void* lpObj);
int ipworks_atom_setchannelcategoryscheme(void* lpObj, const char* lpszChannelCategoryScheme);

Default Value

""

Remarks

This property identifies a categorization scheme.

This property is not available at design time.

Data Type

String

ChannelCategoryTerm Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelCategoryTerm();
int SetChannelCategoryTerm(const char* lpszChannelCategoryTerm); Unicode (Windows) LPWSTR GetChannelCategoryTerm();
INT SetChannelCategoryTerm(LPCWSTR lpszChannelCategoryTerm);
@property (nonatomic,readwrite,assign,getter=channelCategoryTerm,setter=setChannelCategoryTerm:) NSString* channelCategoryTerm;

- (NSString*)channelCategoryTerm;
- (void)setChannelCategoryTerm:(NSString*)newChannelCategoryTerm;
char* ipworks_atom_getchannelcategoryterm(void* lpObj);
int ipworks_atom_setchannelcategoryterm(void* lpObj, const char* lpszChannelCategoryTerm);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelContributorEmail Property (Atom Class)

This property contains the email address of the contributor.

Syntax

ANSI (Cross Platform)
char* GetChannelContributorEmail();
int SetChannelContributorEmail(const char* lpszChannelContributorEmail); Unicode (Windows) LPWSTR GetChannelContributorEmail();
INT SetChannelContributorEmail(LPCWSTR lpszChannelContributorEmail);
@property (nonatomic,readwrite,assign,getter=channelContributorEmail,setter=setChannelContributorEmail:) NSString* channelContributorEmail;

- (NSString*)channelContributorEmail;
- (void)setChannelContributorEmail:(NSString*)newChannelContributorEmail;
char* ipworks_atom_getchannelcontributoremail(void* lpObj);
int ipworks_atom_setchannelcontributoremail(void* lpObj, const char* lpszChannelContributorEmail);

Default Value

""

Remarks

This property contains the email address of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorName Property (Atom Class)

This property contains the name of the contributor.

Syntax

ANSI (Cross Platform)
char* GetChannelContributorName();
int SetChannelContributorName(const char* lpszChannelContributorName); Unicode (Windows) LPWSTR GetChannelContributorName();
INT SetChannelContributorName(LPCWSTR lpszChannelContributorName);
@property (nonatomic,readwrite,assign,getter=channelContributorName,setter=setChannelContributorName:) NSString* channelContributorName;

- (NSString*)channelContributorName;
- (void)setChannelContributorName:(NSString*)newChannelContributorName;
char* ipworks_atom_getchannelcontributorname(void* lpObj);
int ipworks_atom_setchannelcontributorname(void* lpObj, const char* lpszChannelContributorName);

Default Value

""

Remarks

This property contains the name of the contributor.

This property is not available at design time.

Data Type

String

ChannelContributorUri Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelContributorUri();
int SetChannelContributorUri(const char* lpszChannelContributorUri); Unicode (Windows) LPWSTR GetChannelContributorUri();
INT SetChannelContributorUri(LPCWSTR lpszChannelContributorUri);
@property (nonatomic,readwrite,assign,getter=channelContributorUri,setter=setChannelContributorUri:) NSString* channelContributorUri;

- (NSString*)channelContributorUri;
- (void)setChannelContributorUri:(NSString*)newChannelContributorUri;
char* ipworks_atom_getchannelcontributoruri(void* lpObj);
int ipworks_atom_setchannelcontributoruri(void* lpObj, const char* lpszChannelContributorUri);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelGenerator Property (Atom Class)

This property identifies the generator of the feed.

Syntax

ANSI (Cross Platform)
char* GetChannelGenerator();
int SetChannelGenerator(const char* lpszChannelGenerator); Unicode (Windows) LPWSTR GetChannelGenerator();
INT SetChannelGenerator(LPCWSTR lpszChannelGenerator);
@property (nonatomic,readwrite,assign,getter=channelGenerator,setter=setChannelGenerator:) NSString* channelGenerator;

- (NSString*)channelGenerator;
- (void)setChannelGenerator:(NSString*)newChannelGenerator;
char* ipworks_atom_getchannelgenerator(void* lpObj);
int ipworks_atom_setchannelgenerator(void* lpObj, const char* lpszChannelGenerator);

Default Value

""

Remarks

This property identifies the generator of the feed.

This property is not available at design time.

Data Type

String

ChannelIcon Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelIcon();
int SetChannelIcon(const char* lpszChannelIcon); Unicode (Windows) LPWSTR GetChannelIcon();
INT SetChannelIcon(LPCWSTR lpszChannelIcon);
@property (nonatomic,readwrite,assign,getter=channelIcon,setter=setChannelIcon:) NSString* channelIcon;

- (NSString*)channelIcon;
- (void)setChannelIcon:(NSString*)newChannelIcon;
char* ipworks_atom_getchannelicon(void* lpObj);
int ipworks_atom_setchannelicon(void* lpObj, const char* lpszChannelIcon);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelId Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelId();
int SetChannelId(const char* lpszChannelId); Unicode (Windows) LPWSTR GetChannelId();
INT SetChannelId(LPCWSTR lpszChannelId);
@property (nonatomic,readwrite,assign,getter=channelId,setter=setChannelId:) NSString* channelId;

- (NSString*)channelId;
- (void)setChannelId:(NSString*)newChannelId;
char* ipworks_atom_getchannelid(void* lpObj);
int ipworks_atom_setchannelid(void* lpObj, const char* lpszChannelId);

Default Value

""

Remarks

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

Data Type

String

ChannelLinkHref Property (Atom Class)

This property contains the location of the link.

Syntax

ANSI (Cross Platform)
char* GetChannelLinkHref();
int SetChannelLinkHref(const char* lpszChannelLinkHref); Unicode (Windows) LPWSTR GetChannelLinkHref();
INT SetChannelLinkHref(LPCWSTR lpszChannelLinkHref);
@property (nonatomic,readwrite,assign,getter=channelLinkHref,setter=setChannelLinkHref:) NSString* channelLinkHref;

- (NSString*)channelLinkHref;
- (void)setChannelLinkHref:(NSString*)newChannelLinkHref;
char* ipworks_atom_getchannellinkhref(void* lpObj);
int ipworks_atom_setchannellinkhref(void* lpObj, const char* lpszChannelLinkHref);

Default Value

""

Remarks

This property contains the location of the link.

This property is not available at design time.

Data Type

String

ChannelLinkHrefLang Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelLinkHrefLang();
int SetChannelLinkHrefLang(const char* lpszChannelLinkHrefLang); Unicode (Windows) LPWSTR GetChannelLinkHrefLang();
INT SetChannelLinkHrefLang(LPCWSTR lpszChannelLinkHrefLang);
@property (nonatomic,readwrite,assign,getter=channelLinkHrefLang,setter=setChannelLinkHrefLang:) NSString* channelLinkHrefLang;

- (NSString*)channelLinkHrefLang;
- (void)setChannelLinkHrefLang:(NSString*)newChannelLinkHrefLang;
char* ipworks_atom_getchannellinkhreflang(void* lpObj);
int ipworks_atom_setchannellinkhreflang(void* lpObj, const char* lpszChannelLinkHrefLang);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelLinkLength Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelLinkLength();
int SetChannelLinkLength(const char* lpszChannelLinkLength); Unicode (Windows) LPWSTR GetChannelLinkLength();
INT SetChannelLinkLength(LPCWSTR lpszChannelLinkLength);
@property (nonatomic,readwrite,assign,getter=channelLinkLength,setter=setChannelLinkLength:) NSString* channelLinkLength;

- (NSString*)channelLinkLength;
- (void)setChannelLinkLength:(NSString*)newChannelLinkLength;
char* ipworks_atom_getchannellinklength(void* lpObj);
int ipworks_atom_setchannellinklength(void* lpObj, const char* lpszChannelLinkLength);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelLinkRel Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelLinkRel();
int SetChannelLinkRel(const char* lpszChannelLinkRel); Unicode (Windows) LPWSTR GetChannelLinkRel();
INT SetChannelLinkRel(LPCWSTR lpszChannelLinkRel);
@property (nonatomic,readwrite,assign,getter=channelLinkRel,setter=setChannelLinkRel:) NSString* channelLinkRel;

- (NSString*)channelLinkRel;
- (void)setChannelLinkRel:(NSString*)newChannelLinkRel;
char* ipworks_atom_getchannellinkrel(void* lpObj);
int ipworks_atom_setchannellinkrel(void* lpObj, const char* lpszChannelLinkRel);

Default Value

""

Remarks

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

  • alternate
  • related
  • self
  • enclosure
  • via

This property is not available at design time.

Data Type

String

ChannelLinkTitle Property (Atom Class)

This property contains the title of the link.

Syntax

ANSI (Cross Platform)
char* GetChannelLinkTitle();
int SetChannelLinkTitle(const char* lpszChannelLinkTitle); Unicode (Windows) LPWSTR GetChannelLinkTitle();
INT SetChannelLinkTitle(LPCWSTR lpszChannelLinkTitle);
@property (nonatomic,readwrite,assign,getter=channelLinkTitle,setter=setChannelLinkTitle:) NSString* channelLinkTitle;

- (NSString*)channelLinkTitle;
- (void)setChannelLinkTitle:(NSString*)newChannelLinkTitle;
char* ipworks_atom_getchannellinktitle(void* lpObj);
int ipworks_atom_setchannellinktitle(void* lpObj, const char* lpszChannelLinkTitle);

Default Value

""

Remarks

This property contains the title of the link.

This property is not available at design time.

Data Type

String

ChannelLinkType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelLinkType();
int SetChannelLinkType(const char* lpszChannelLinkType); Unicode (Windows) LPWSTR GetChannelLinkType();
INT SetChannelLinkType(LPCWSTR lpszChannelLinkType);
@property (nonatomic,readwrite,assign,getter=channelLinkType,setter=setChannelLinkType:) NSString* channelLinkType;

- (NSString*)channelLinkType;
- (void)setChannelLinkType:(NSString*)newChannelLinkType;
char* ipworks_atom_getchannellinktype(void* lpObj);
int ipworks_atom_setchannellinktype(void* lpObj, const char* lpszChannelLinkType);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelLogo Property (Atom Class)

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

Syntax

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelRights Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelRights();
int SetChannelRights(const char* lpszChannelRights); Unicode (Windows) LPWSTR GetChannelRights();
INT SetChannelRights(LPCWSTR lpszChannelRights);
@property (nonatomic,readwrite,assign,getter=channelRights,setter=setChannelRights:) NSString* channelRights;

- (NSString*)channelRights;
- (void)setChannelRights:(NSString*)newChannelRights;
char* ipworks_atom_getchannelrights(void* lpObj);
int ipworks_atom_setchannelrights(void* lpObj, const char* lpszChannelRights);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ChannelRightsTextType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetChannelRightsTextType();
int SetChannelRightsTextType(int iChannelRightsTextType); Unicode (Windows) INT GetChannelRightsTextType();
INT SetChannelRightsTextType(INT iChannelRightsTextType);

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
@property (nonatomic,readwrite,assign,getter=channelRightsTextType,setter=setChannelRightsTextType:) int channelRightsTextType;

- (int)channelRightsTextType;
- (void)setChannelRightsTextType:(int)newChannelRightsTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getchannelrightstexttype(void* lpObj);
int ipworks_atom_setchannelrightstexttype(void* lpObj, int iChannelRightsTextType);

Default Value

0

Remarks

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

Data Type

Integer

ChannelSubtitle Property (Atom Class)

This property contains a short description of the Atom feed.

Syntax

ANSI (Cross Platform)
char* GetChannelSubtitle();
int SetChannelSubtitle(const char* lpszChannelSubtitle); Unicode (Windows) LPWSTR GetChannelSubtitle();
INT SetChannelSubtitle(LPCWSTR lpszChannelSubtitle);
@property (nonatomic,readwrite,assign,getter=channelSubtitle,setter=setChannelSubtitle:) NSString* channelSubtitle;

- (NSString*)channelSubtitle;
- (void)setChannelSubtitle:(NSString*)newChannelSubtitle;
char* ipworks_atom_getchannelsubtitle(void* lpObj);
int ipworks_atom_setchannelsubtitle(void* lpObj, const char* lpszChannelSubtitle);

Default Value

""

Remarks

This property contains a short description of the Atom feed.

Data Type

String

ChannelSubtitleTextType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetChannelSubtitleTextType();
int SetChannelSubtitleTextType(int iChannelSubtitleTextType); Unicode (Windows) INT GetChannelSubtitleTextType();
INT SetChannelSubtitleTextType(INT iChannelSubtitleTextType);

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
@property (nonatomic,readwrite,assign,getter=channelSubtitleTextType,setter=setChannelSubtitleTextType:) int channelSubtitleTextType;

- (int)channelSubtitleTextType;
- (void)setChannelSubtitleTextType:(int)newChannelSubtitleTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getchannelsubtitletexttype(void* lpObj);
int ipworks_atom_setchannelsubtitletexttype(void* lpObj, int iChannelSubtitleTextType);

Default Value

0

Remarks

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

Data Type

Integer

ChannelTitle Property (Atom Class)

This property contains the title of the current Atom feed.

Syntax

ANSI (Cross Platform)
char* GetChannelTitle();
int SetChannelTitle(const char* lpszChannelTitle); Unicode (Windows) LPWSTR GetChannelTitle();
INT SetChannelTitle(LPCWSTR lpszChannelTitle);
@property (nonatomic,readwrite,assign,getter=channelTitle,setter=setChannelTitle:) NSString* channelTitle;

- (NSString*)channelTitle;
- (void)setChannelTitle:(NSString*)newChannelTitle;
char* ipworks_atom_getchanneltitle(void* lpObj);
int ipworks_atom_setchanneltitle(void* lpObj, const char* lpszChannelTitle);

Default Value

""

Remarks

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

Data Type

String

ChannelTitleTextType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetChannelTitleTextType();
int SetChannelTitleTextType(int iChannelTitleTextType); Unicode (Windows) INT GetChannelTitleTextType();
INT SetChannelTitleTextType(INT iChannelTitleTextType);

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
@property (nonatomic,readwrite,assign,getter=channelTitleTextType,setter=setChannelTitleTextType:) int channelTitleTextType;

- (int)channelTitleTextType;
- (void)setChannelTitleTextType:(int)newChannelTitleTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getchanneltitletexttype(void* lpObj);
int ipworks_atom_setchanneltitletexttype(void* lpObj, int iChannelTitleTextType);

Default Value

0

Remarks

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

Data Type

Integer

ChannelUpdated Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetChannelUpdated();
int SetChannelUpdated(const char* lpszChannelUpdated); Unicode (Windows) LPWSTR GetChannelUpdated();
INT SetChannelUpdated(LPCWSTR lpszChannelUpdated);
@property (nonatomic,readwrite,assign,getter=channelUpdated,setter=setChannelUpdated:) NSString* channelUpdated;

- (NSString*)channelUpdated;
- (void)setChannelUpdated:(NSString*)newChannelUpdated;
char* ipworks_atom_getchannelupdated(void* lpObj);
int ipworks_atom_setchannelupdated(void* lpObj, const char* lpszChannelUpdated);

Default Value

""

Remarks

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

Data Type

String

Connected Property (Atom Class)

Shows whether the class is connected.

Syntax

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected); Unicode (Windows) BOOL GetConnected();
INT SetConnected(BOOL bConnected);
@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected:(BOOL)newConnected;
int ipworks_atom_getconnected(void* lpObj);
int ipworks_atom_setconnected(void* lpObj, int bConnected);

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

ContentType Property (Atom Class)

This is the content type for posts and puts.

Syntax

ANSI (Cross Platform)
char* GetContentType();
int SetContentType(const char* lpszContentType); Unicode (Windows) LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);
@property (nonatomic,readwrite,assign,getter=contentType,setter=setContentType:) NSString* contentType;

- (NSString*)contentType;
- (void)setContentType:(NSString*)newContentType;
char* ipworks_atom_getcontenttype(void* lpObj);
int ipworks_atom_setcontenttype(void* lpObj, const char* lpszContentType);

Default Value

"application/atom+xml"

Remarks

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

This property is not available at design time.

Data Type

String

CookieCount Property (Atom Class)

The number of records in the Cookie arrays.

Syntax

ANSI (Cross Platform)
int GetCookieCount();
int SetCookieCount(int iCookieCount); Unicode (Windows) INT GetCookieCount();
INT SetCookieCount(INT iCookieCount);
@property (nonatomic,readwrite,assign,getter=cookieCount,setter=setCookieCount:) int cookieCount;

- (int)cookieCount;
- (void)setCookieCount:(int)newCookieCount;
int ipworks_atom_getcookiecount(void* lpObj);
int ipworks_atom_setcookiecount(void* lpObj, int iCookieCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (Atom Class)

The domain of a received cookie.

Syntax

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

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);
- (NSString*)cookieDomain:(int)cookieIndex;
char* ipworks_atom_getcookiedomain(void* lpObj, int cookieindex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieExpiration Property (Atom Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);
- (NSString*)cookieExpiration:(int)cookieIndex;
char* ipworks_atom_getcookieexpiration(void* lpObj, int cookieindex);

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

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

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

Data Type

String

CookieName Property (Atom Class)

The name of the cookie.

Syntax

ANSI (Cross Platform)
char* GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, const char* lpszCookieName); Unicode (Windows) LPWSTR GetCookieName(INT iCookieIndex);
INT SetCookieName(INT iCookieIndex, LPCWSTR lpszCookieName);
- (NSString*)cookieName:(int)cookieIndex;
- (void)setCookieName:(int)cookieIndex:(NSString*)newCookieName;
char* ipworks_atom_getcookiename(void* lpObj, int cookieindex);
int ipworks_atom_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

Default Value

""

Remarks

The name of the cookie.

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

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

This property is not available at design time.

Data Type

String

CookiePath Property (Atom Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);
- (NSString*)cookiePath:(int)cookieIndex;
char* ipworks_atom_getcookiepath(void* lpObj, int cookieindex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieSecure Property (Atom Class)

This property contains the security flag of the received cookie.

Syntax

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

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);
- (BOOL)cookieSecure:(int)cookieIndex;
int ipworks_atom_getcookiesecure(void* lpObj, int cookieindex);

Default Value

FALSE

Remarks

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

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

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

Data Type

Boolean

CookieValue Property (Atom Class)

This property contains the value of the cookie.

Syntax

ANSI (Cross Platform)
char* GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, const char* lpszCookieValue); Unicode (Windows) LPWSTR GetCookieValue(INT iCookieIndex);
INT SetCookieValue(INT iCookieIndex, LPCWSTR lpszCookieValue);
- (NSString*)cookieValue:(int)cookieIndex;
- (void)setCookieValue:(int)cookieIndex:(NSString*)newCookieValue;
char* ipworks_atom_getcookievalue(void* lpObj, int cookieindex);
int ipworks_atom_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

Default Value

""

Remarks

This property contains the value of the cookie. The cookie specified by CookieName has a corresponding value associated with it. This property holds that value.

The SetCookie event provides the cookies set by the server.

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

This property is not available at design time.

Data Type

String

EntryCount Property (Atom Class)

The number of records in the Entry arrays.

Syntax

ANSI (Cross Platform)
int GetEntryCount();
int SetEntryCount(int iEntryCount); Unicode (Windows) INT GetEntryCount();
INT SetEntryCount(INT iEntryCount);
@property (nonatomic,readwrite,assign,getter=entryCount,setter=setEntryCount:) int entryCount;

- (int)entryCount;
- (void)setEntryCount:(int)newEntryCount;
int ipworks_atom_getentrycount(void* lpObj);
int ipworks_atom_setentrycount(void* lpObj, int iEntryCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

EntryAuthorEmail Property (Atom Class)

This property contains the email address of the author.

Syntax

ANSI (Cross Platform)
char* GetEntryAuthorEmail(int iEntryIndex);
int SetEntryAuthorEmail(int iEntryIndex, const char* lpszEntryAuthorEmail); Unicode (Windows) LPWSTR GetEntryAuthorEmail(INT iEntryIndex);
INT SetEntryAuthorEmail(INT iEntryIndex, LPCWSTR lpszEntryAuthorEmail);
- (NSString*)entryAuthorEmail:(int)entryIndex;
- (void)setEntryAuthorEmail:(int)entryIndex:(NSString*)newEntryAuthorEmail;
char* ipworks_atom_getentryauthoremail(void* lpObj, int entryindex);
int ipworks_atom_setentryauthoremail(void* lpObj, int entryindex, const char* lpszEntryAuthorEmail);

Default Value

""

Remarks

This property contains the email address of the author.

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

This property is not available at design time.

Data Type

String

EntryAuthorName Property (Atom Class)

This property contains the name of the author.

Syntax

ANSI (Cross Platform)
char* GetEntryAuthorName(int iEntryIndex);
int SetEntryAuthorName(int iEntryIndex, const char* lpszEntryAuthorName); Unicode (Windows) LPWSTR GetEntryAuthorName(INT iEntryIndex);
INT SetEntryAuthorName(INT iEntryIndex, LPCWSTR lpszEntryAuthorName);
- (NSString*)entryAuthorName:(int)entryIndex;
- (void)setEntryAuthorName:(int)entryIndex:(NSString*)newEntryAuthorName;
char* ipworks_atom_getentryauthorname(void* lpObj, int entryindex);
int ipworks_atom_setentryauthorname(void* lpObj, int entryindex, const char* lpszEntryAuthorName);

Default Value

""

Remarks

This property contains the name of the author.

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

This property is not available at design time.

Data Type

String

EntryAuthorUri Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryAuthorUri(int iEntryIndex);
int SetEntryAuthorUri(int iEntryIndex, const char* lpszEntryAuthorUri); Unicode (Windows) LPWSTR GetEntryAuthorUri(INT iEntryIndex);
INT SetEntryAuthorUri(INT iEntryIndex, LPCWSTR lpszEntryAuthorUri);
- (NSString*)entryAuthorUri:(int)entryIndex;
- (void)setEntryAuthorUri:(int)entryIndex:(NSString*)newEntryAuthorUri;
char* ipworks_atom_getentryauthoruri(void* lpObj, int entryindex);
int ipworks_atom_setentryauthoruri(void* lpObj, int entryindex, const char* lpszEntryAuthorUri);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryCategoryLabel Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryCategoryLabel(int iEntryIndex);
int SetEntryCategoryLabel(int iEntryIndex, const char* lpszEntryCategoryLabel); Unicode (Windows) LPWSTR GetEntryCategoryLabel(INT iEntryIndex);
INT SetEntryCategoryLabel(INT iEntryIndex, LPCWSTR lpszEntryCategoryLabel);
- (NSString*)entryCategoryLabel:(int)entryIndex;
- (void)setEntryCategoryLabel:(int)entryIndex:(NSString*)newEntryCategoryLabel;
char* ipworks_atom_getentrycategorylabel(void* lpObj, int entryindex);
int ipworks_atom_setentrycategorylabel(void* lpObj, int entryindex, const char* lpszEntryCategoryLabel);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryCategoryScheme Property (Atom Class)

This property identifies a categorization scheme.

Syntax

ANSI (Cross Platform)
char* GetEntryCategoryScheme(int iEntryIndex);
int SetEntryCategoryScheme(int iEntryIndex, const char* lpszEntryCategoryScheme); Unicode (Windows) LPWSTR GetEntryCategoryScheme(INT iEntryIndex);
INT SetEntryCategoryScheme(INT iEntryIndex, LPCWSTR lpszEntryCategoryScheme);
- (NSString*)entryCategoryScheme:(int)entryIndex;
- (void)setEntryCategoryScheme:(int)entryIndex:(NSString*)newEntryCategoryScheme;
char* ipworks_atom_getentrycategoryscheme(void* lpObj, int entryindex);
int ipworks_atom_setentrycategoryscheme(void* lpObj, int entryindex, const char* lpszEntryCategoryScheme);

Default Value

""

Remarks

This property identifies a categorization scheme.

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

This property is not available at design time.

Data Type

String

EntryCategoryTerm Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryCategoryTerm(int iEntryIndex);
int SetEntryCategoryTerm(int iEntryIndex, const char* lpszEntryCategoryTerm); Unicode (Windows) LPWSTR GetEntryCategoryTerm(INT iEntryIndex);
INT SetEntryCategoryTerm(INT iEntryIndex, LPCWSTR lpszEntryCategoryTerm);
- (NSString*)entryCategoryTerm:(int)entryIndex;
- (void)setEntryCategoryTerm:(int)entryIndex:(NSString*)newEntryCategoryTerm;
char* ipworks_atom_getentrycategoryterm(void* lpObj, int entryindex);
int ipworks_atom_setentrycategoryterm(void* lpObj, int entryindex, const char* lpszEntryCategoryTerm);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryContent Property (Atom Class)

This property contains the text contents of an Atom entry.

Syntax

ANSI (Cross Platform)
char* GetEntryContent(int iEntryIndex);
int SetEntryContent(int iEntryIndex, const char* lpszEntryContent); Unicode (Windows) LPWSTR GetEntryContent(INT iEntryIndex);
INT SetEntryContent(INT iEntryIndex, LPCWSTR lpszEntryContent);
- (NSString*)entryContent:(int)entryIndex;
- (void)setEntryContent:(int)entryIndex:(NSString*)newEntryContent;
char* ipworks_atom_getentrycontent(void* lpObj, int entryindex);
int ipworks_atom_setentrycontent(void* lpObj, int entryindex, const char* lpszEntryContent);

Default Value

""

Remarks

This property contains the text contents of an Atom entry.

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

This property is not available at design time.

Data Type

String

EntryContentTextType Property (Atom Class)

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

Syntax

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

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
- (int)entryContentTextType:(int)entryIndex;
- (void)setEntryContentTextType:(int)entryIndex:(int)newEntryContentTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getentrycontenttexttype(void* lpObj, int entryindex);
int ipworks_atom_setentrycontenttexttype(void* lpObj, int entryindex, int iEntryContentTextType);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

EntryContributorEmail Property (Atom Class)

This property contains the email address of the contributor.

Syntax

ANSI (Cross Platform)
char* GetEntryContributorEmail(int iEntryIndex);
int SetEntryContributorEmail(int iEntryIndex, const char* lpszEntryContributorEmail); Unicode (Windows) LPWSTR GetEntryContributorEmail(INT iEntryIndex);
INT SetEntryContributorEmail(INT iEntryIndex, LPCWSTR lpszEntryContributorEmail);
- (NSString*)entryContributorEmail:(int)entryIndex;
- (void)setEntryContributorEmail:(int)entryIndex:(NSString*)newEntryContributorEmail;
char* ipworks_atom_getentrycontributoremail(void* lpObj, int entryindex);
int ipworks_atom_setentrycontributoremail(void* lpObj, int entryindex, const char* lpszEntryContributorEmail);

Default Value

""

Remarks

This property contains the email address of the contributor.

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

This property is not available at design time.

Data Type

String

EntryContributorName Property (Atom Class)

This property contains the name of the contributor.

Syntax

ANSI (Cross Platform)
char* GetEntryContributorName(int iEntryIndex);
int SetEntryContributorName(int iEntryIndex, const char* lpszEntryContributorName); Unicode (Windows) LPWSTR GetEntryContributorName(INT iEntryIndex);
INT SetEntryContributorName(INT iEntryIndex, LPCWSTR lpszEntryContributorName);
- (NSString*)entryContributorName:(int)entryIndex;
- (void)setEntryContributorName:(int)entryIndex:(NSString*)newEntryContributorName;
char* ipworks_atom_getentrycontributorname(void* lpObj, int entryindex);
int ipworks_atom_setentrycontributorname(void* lpObj, int entryindex, const char* lpszEntryContributorName);

Default Value

""

Remarks

This property contains the name of the contributor.

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

This property is not available at design time.

Data Type

String

EntryContributorUri Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryContributorUri(int iEntryIndex);
int SetEntryContributorUri(int iEntryIndex, const char* lpszEntryContributorUri); Unicode (Windows) LPWSTR GetEntryContributorUri(INT iEntryIndex);
INT SetEntryContributorUri(INT iEntryIndex, LPCWSTR lpszEntryContributorUri);
- (NSString*)entryContributorUri:(int)entryIndex;
- (void)setEntryContributorUri:(int)entryIndex:(NSString*)newEntryContributorUri;
char* ipworks_atom_getentrycontributoruri(void* lpObj, int entryindex);
int ipworks_atom_setentrycontributoruri(void* lpObj, int entryindex, const char* lpszEntryContributorUri);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryCopyright Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryCopyright(int iEntryIndex);
int SetEntryCopyright(int iEntryIndex, const char* lpszEntryCopyright); Unicode (Windows) LPWSTR GetEntryCopyright(INT iEntryIndex);
INT SetEntryCopyright(INT iEntryIndex, LPCWSTR lpszEntryCopyright);
- (NSString*)entryCopyright:(int)entryIndex;
- (void)setEntryCopyright:(int)entryIndex:(NSString*)newEntryCopyright;
char* ipworks_atom_getentrycopyright(void* lpObj, int entryindex);
int ipworks_atom_setentrycopyright(void* lpObj, int entryindex, const char* lpszEntryCopyright);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryCreated Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryCreated(int iEntryIndex);
int SetEntryCreated(int iEntryIndex, const char* lpszEntryCreated); Unicode (Windows) LPWSTR GetEntryCreated(INT iEntryIndex);
INT SetEntryCreated(INT iEntryIndex, LPCWSTR lpszEntryCreated);
- (NSString*)entryCreated:(int)entryIndex;
- (void)setEntryCreated:(int)entryIndex:(NSString*)newEntryCreated;
char* ipworks_atom_getentrycreated(void* lpObj, int entryindex);
int ipworks_atom_setentrycreated(void* lpObj, int entryindex, const char* lpszEntryCreated);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryXML Property (Atom Class)

This property contains the full XML contents of the entry.

Syntax

ANSI (Cross Platform)
char* GetEntryXML(int iEntryIndex);
int SetEntryXML(int iEntryIndex, const char* lpszEntryXML); Unicode (Windows) LPWSTR GetEntryXML(INT iEntryIndex);
INT SetEntryXML(INT iEntryIndex, LPCWSTR lpszEntryXML);
- (NSString*)entryXML:(int)entryIndex;
- (void)setEntryXML:(int)entryIndex:(NSString*)newEntryXML;
char* ipworks_atom_getentryxml(void* lpObj, int entryindex);
int ipworks_atom_setentryxml(void* lpObj, int entryindex, const char* lpszEntryXML);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

EntryId Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryId(int iEntryIndex);
int SetEntryId(int iEntryIndex, const char* lpszEntryId); Unicode (Windows) LPWSTR GetEntryId(INT iEntryIndex);
INT SetEntryId(INT iEntryIndex, LPCWSTR lpszEntryId);
- (NSString*)entryId:(int)entryIndex;
- (void)setEntryId:(int)entryIndex:(NSString*)newEntryId;
char* ipworks_atom_getentryid(void* lpObj, int entryindex);
int ipworks_atom_setentryid(void* lpObj, int entryindex, const char* lpszEntryId);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryIssued Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryIssued(int iEntryIndex);
int SetEntryIssued(int iEntryIndex, const char* lpszEntryIssued); Unicode (Windows) LPWSTR GetEntryIssued(INT iEntryIndex);
INT SetEntryIssued(INT iEntryIndex, LPCWSTR lpszEntryIssued);
- (NSString*)entryIssued:(int)entryIndex;
- (void)setEntryIssued:(int)entryIndex:(NSString*)newEntryIssued;
char* ipworks_atom_getentryissued(void* lpObj, int entryindex);
int ipworks_atom_setentryissued(void* lpObj, int entryindex, const char* lpszEntryIssued);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryLinkHref Property (Atom Class)

This property contains the location of the link.

Syntax

ANSI (Cross Platform)
char* GetEntryLinkHref(int iEntryIndex);
int SetEntryLinkHref(int iEntryIndex, const char* lpszEntryLinkHref); Unicode (Windows) LPWSTR GetEntryLinkHref(INT iEntryIndex);
INT SetEntryLinkHref(INT iEntryIndex, LPCWSTR lpszEntryLinkHref);
- (NSString*)entryLinkHref:(int)entryIndex;
- (void)setEntryLinkHref:(int)entryIndex:(NSString*)newEntryLinkHref;
char* ipworks_atom_getentrylinkhref(void* lpObj, int entryindex);
int ipworks_atom_setentrylinkhref(void* lpObj, int entryindex, const char* lpszEntryLinkHref);

Default Value

""

Remarks

This property contains the location of the link.

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

This property is not available at design time.

Data Type

String

EntryLinkHrefLang Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryLinkHrefLang(int iEntryIndex);
int SetEntryLinkHrefLang(int iEntryIndex, const char* lpszEntryLinkHrefLang); Unicode (Windows) LPWSTR GetEntryLinkHrefLang(INT iEntryIndex);
INT SetEntryLinkHrefLang(INT iEntryIndex, LPCWSTR lpszEntryLinkHrefLang);
- (NSString*)entryLinkHrefLang:(int)entryIndex;
- (void)setEntryLinkHrefLang:(int)entryIndex:(NSString*)newEntryLinkHrefLang;
char* ipworks_atom_getentrylinkhreflang(void* lpObj, int entryindex);
int ipworks_atom_setentrylinkhreflang(void* lpObj, int entryindex, const char* lpszEntryLinkHrefLang);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryLinkLength Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryLinkLength(int iEntryIndex);
int SetEntryLinkLength(int iEntryIndex, const char* lpszEntryLinkLength); Unicode (Windows) LPWSTR GetEntryLinkLength(INT iEntryIndex);
INT SetEntryLinkLength(INT iEntryIndex, LPCWSTR lpszEntryLinkLength);
- (NSString*)entryLinkLength:(int)entryIndex;
- (void)setEntryLinkLength:(int)entryIndex:(NSString*)newEntryLinkLength;
char* ipworks_atom_getentrylinklength(void* lpObj, int entryindex);
int ipworks_atom_setentrylinklength(void* lpObj, int entryindex, const char* lpszEntryLinkLength);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryLinkRel Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryLinkRel(int iEntryIndex);
int SetEntryLinkRel(int iEntryIndex, const char* lpszEntryLinkRel); Unicode (Windows) LPWSTR GetEntryLinkRel(INT iEntryIndex);
INT SetEntryLinkRel(INT iEntryIndex, LPCWSTR lpszEntryLinkRel);
- (NSString*)entryLinkRel:(int)entryIndex;
- (void)setEntryLinkRel:(int)entryIndex:(NSString*)newEntryLinkRel;
char* ipworks_atom_getentrylinkrel(void* lpObj, int entryindex);
int ipworks_atom_setentrylinkrel(void* lpObj, int entryindex, const char* lpszEntryLinkRel);

Default Value

""

Remarks

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

  • alternate
  • related
  • self
  • enclosure
  • via

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

This property is not available at design time.

Data Type

String

EntryLinkTitle Property (Atom Class)

This property contains the title of the link.

Syntax

ANSI (Cross Platform)
char* GetEntryLinkTitle(int iEntryIndex);
int SetEntryLinkTitle(int iEntryIndex, const char* lpszEntryLinkTitle); Unicode (Windows) LPWSTR GetEntryLinkTitle(INT iEntryIndex);
INT SetEntryLinkTitle(INT iEntryIndex, LPCWSTR lpszEntryLinkTitle);
- (NSString*)entryLinkTitle:(int)entryIndex;
- (void)setEntryLinkTitle:(int)entryIndex:(NSString*)newEntryLinkTitle;
char* ipworks_atom_getentrylinktitle(void* lpObj, int entryindex);
int ipworks_atom_setentrylinktitle(void* lpObj, int entryindex, const char* lpszEntryLinkTitle);

Default Value

""

Remarks

This property contains the title of the link.

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

This property is not available at design time.

Data Type

String

EntryLinkType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryLinkType(int iEntryIndex);
int SetEntryLinkType(int iEntryIndex, const char* lpszEntryLinkType); Unicode (Windows) LPWSTR GetEntryLinkType(INT iEntryIndex);
INT SetEntryLinkType(INT iEntryIndex, LPCWSTR lpszEntryLinkType);
- (NSString*)entryLinkType:(int)entryIndex;
- (void)setEntryLinkType:(int)entryIndex:(NSString*)newEntryLinkType;
char* ipworks_atom_getentrylinktype(void* lpObj, int entryindex);
int ipworks_atom_setentrylinktype(void* lpObj, int entryindex, const char* lpszEntryLinkType);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryModified Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryModified(int iEntryIndex);
int SetEntryModified(int iEntryIndex, const char* lpszEntryModified); Unicode (Windows) LPWSTR GetEntryModified(INT iEntryIndex);
INT SetEntryModified(INT iEntryIndex, LPCWSTR lpszEntryModified);
- (NSString*)entryModified:(int)entryIndex;
- (void)setEntryModified:(int)entryIndex:(NSString*)newEntryModified;
char* ipworks_atom_getentrymodified(void* lpObj, int entryindex);
int ipworks_atom_setentrymodified(void* lpObj, int entryindex, const char* lpszEntryModified);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryPublished Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryPublished(int iEntryIndex);
int SetEntryPublished(int iEntryIndex, const char* lpszEntryPublished); Unicode (Windows) LPWSTR GetEntryPublished(INT iEntryIndex);
INT SetEntryPublished(INT iEntryIndex, LPCWSTR lpszEntryPublished);
- (NSString*)entryPublished:(int)entryIndex;
- (void)setEntryPublished:(int)entryIndex:(NSString*)newEntryPublished;
char* ipworks_atom_getentrypublished(void* lpObj, int entryindex);
int ipworks_atom_setentrypublished(void* lpObj, int entryindex, const char* lpszEntryPublished);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryRights Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryRights(int iEntryIndex);
int SetEntryRights(int iEntryIndex, const char* lpszEntryRights); Unicode (Windows) LPWSTR GetEntryRights(INT iEntryIndex);
INT SetEntryRights(INT iEntryIndex, LPCWSTR lpszEntryRights);
- (NSString*)entryRights:(int)entryIndex;
- (void)setEntryRights:(int)entryIndex:(NSString*)newEntryRights;
char* ipworks_atom_getentryrights(void* lpObj, int entryindex);
int ipworks_atom_setentryrights(void* lpObj, int entryindex, const char* lpszEntryRights);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryRightsTextType Property (Atom Class)

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

Syntax

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

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
- (int)entryRightsTextType:(int)entryIndex;
- (void)setEntryRightsTextType:(int)entryIndex:(int)newEntryRightsTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getentryrightstexttype(void* lpObj, int entryindex);
int ipworks_atom_setentryrightstexttype(void* lpObj, int entryindex, int iEntryRightsTextType);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

EntrySource Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntrySource(int iEntryIndex);
int SetEntrySource(int iEntryIndex, const char* lpszEntrySource); Unicode (Windows) LPWSTR GetEntrySource(INT iEntryIndex);
INT SetEntrySource(INT iEntryIndex, LPCWSTR lpszEntrySource);
- (NSString*)entrySource:(int)entryIndex;
- (void)setEntrySource:(int)entryIndex:(NSString*)newEntrySource;
char* ipworks_atom_getentrysource(void* lpObj, int entryindex);
int ipworks_atom_setentrysource(void* lpObj, int entryindex, const char* lpszEntrySource);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntrySummary Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntrySummary(int iEntryIndex);
int SetEntrySummary(int iEntryIndex, const char* lpszEntrySummary); Unicode (Windows) LPWSTR GetEntrySummary(INT iEntryIndex);
INT SetEntrySummary(INT iEntryIndex, LPCWSTR lpszEntrySummary);
- (NSString*)entrySummary:(int)entryIndex;
- (void)setEntrySummary:(int)entryIndex:(NSString*)newEntrySummary;
char* ipworks_atom_getentrysummary(void* lpObj, int entryindex);
int ipworks_atom_setentrysummary(void* lpObj, int entryindex, const char* lpszEntrySummary);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntrySummaryTextType Property (Atom Class)

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

Syntax

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

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
- (int)entrySummaryTextType:(int)entryIndex;
- (void)setEntrySummaryTextType:(int)entryIndex:(int)newEntrySummaryTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getentrysummarytexttype(void* lpObj, int entryindex);
int ipworks_atom_setentrysummarytexttype(void* lpObj, int entryindex, int iEntrySummaryTextType);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

EntryTitle Property (Atom Class)

This property contains the title of the current Atom Feed.

Syntax

ANSI (Cross Platform)
char* GetEntryTitle(int iEntryIndex);
int SetEntryTitle(int iEntryIndex, const char* lpszEntryTitle); Unicode (Windows) LPWSTR GetEntryTitle(INT iEntryIndex);
INT SetEntryTitle(INT iEntryIndex, LPCWSTR lpszEntryTitle);
- (NSString*)entryTitle:(int)entryIndex;
- (void)setEntryTitle:(int)entryIndex:(NSString*)newEntryTitle;
char* ipworks_atom_getentrytitle(void* lpObj, int entryindex);
int ipworks_atom_setentrytitle(void* lpObj, int entryindex, const char* lpszEntryTitle);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

EntryTitleTextType Property (Atom Class)

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

Syntax

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

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
- (int)entryTitleTextType:(int)entryIndex;
- (void)setEntryTitleTextType:(int)entryIndex:(int)newEntryTitleTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getentrytitletexttype(void* lpObj, int entryindex);
int ipworks_atom_setentrytitletexttype(void* lpObj, int entryindex, int iEntryTitleTextType);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

EntryUpdated Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetEntryUpdated(int iEntryIndex);
int SetEntryUpdated(int iEntryIndex, const char* lpszEntryUpdated); Unicode (Windows) LPWSTR GetEntryUpdated(INT iEntryIndex);
INT SetEntryUpdated(INT iEntryIndex, LPCWSTR lpszEntryUpdated);
- (NSString*)entryUpdated:(int)entryIndex;
- (void)setEntryUpdated:(int)entryIndex:(NSString*)newEntryUpdated;
char* ipworks_atom_getentryupdated(void* lpObj, int entryindex);
int ipworks_atom_setentryupdated(void* lpObj, int entryindex, const char* lpszEntryUpdated);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect:(BOOL)newFirewallAutoDetect;
int ipworks_atom_getfirewallautodetect(void* lpObj);
int ipworks_atom_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (Atom Class)

This property determines the type of firewall to connect through.

Syntax

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

Possible Values

FW_NONE(0), 
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType:(int)newFirewallType;

Possible Values

FW_NONE(0), 
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int ipworks_atom_getfirewalltype(void* lpObj);
int ipworks_atom_setfirewalltype(void* lpObj, int iFirewallType);

Default Value

0

Remarks

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

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost:(NSString*)newFirewallHost;
char* ipworks_atom_getfirewallhost(void* lpObj);
int ipworks_atom_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword:(NSString*)newFirewallPassword;
char* ipworks_atom_getfirewallpassword(void* lpObj);
int ipworks_atom_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (Atom Class)

This property contains the TCP port for the firewall Host .

Syntax

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort:(int)newFirewallPort;
int ipworks_atom_getfirewallport(void* lpObj);
int ipworks_atom_setfirewallport(void* lpObj, int iFirewallPort);

Default Value

0

Remarks

This property contains the TCP port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note that this property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser:(NSString*)newFirewallUser;
char* ipworks_atom_getfirewalluser(void* lpObj);
int ipworks_atom_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

Default Value

""

Remarks

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

Data Type

String

FollowRedirects Property (Atom Class)

Determines what happens when the server issues a redirect.

Syntax

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects); Unicode (Windows) INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

Possible Values

FR_NEVER(0), 
FR_ALWAYS(1),
FR_SAME_SCHEME(2)
@property (nonatomic,readwrite,assign,getter=followRedirects,setter=setFollowRedirects:) int followRedirects;

- (int)followRedirects;
- (void)setFollowRedirects:(int)newFollowRedirects;

Possible Values

FR_NEVER(0), 
FR_ALWAYS(1),
FR_SAME_SCHEME(2)
int ipworks_atom_getfollowredirects(void* lpObj);
int ipworks_atom_setfollowredirects(void* lpObj, int iFollowRedirects);

Default Value

0

Remarks

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

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

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

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless this property is set to frAlways (1), in which case the same credentials are used to connect to the new server.

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

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

Data Type

Integer

Idle Property (Atom Class)

The current status of the class.

Syntax

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();
@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;
int ipworks_atom_getidle(void* lpObj);

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (Atom Class)

A date determining the maximum age of the desired document.

Syntax

ANSI (Cross Platform)
char* GetIfModifiedSince();
int SetIfModifiedSince(const char* lpszIfModifiedSince); Unicode (Windows) LPWSTR GetIfModifiedSince();
INT SetIfModifiedSince(LPCWSTR lpszIfModifiedSince);
@property (nonatomic,readwrite,assign,getter=ifModifiedSince,setter=setIfModifiedSince:) NSString* ifModifiedSince;

- (NSString*)ifModifiedSince;
- (void)setIfModifiedSince:(NSString*)newIfModifiedSince;
char* ipworks_atom_getifmodifiedsince(void* lpObj);
int ipworks_atom_setifmodifiedsince(void* lpObj, const char* lpszIfModifiedSince);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

LocalFile Property (Atom Class)

The path to a local file for downloading. If the file exists, it is overwritten.

Syntax

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);
@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile:(NSString*)newLocalFile;
char* ipworks_atom_getlocalfile(void* lpObj);
wchar_t* ipworks_atom_getlocalfile_W(void* lpObj); // Windows only
int ipworks_atom_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_atom_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

Default Value

""

Remarks

This property is used when getting a document.

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

Data Type

String

LocalHost Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost:(NSString*)newLocalHost;
char* ipworks_atom_getlocalhost(void* lpObj);
int ipworks_atom_setlocalhost(void* lpObj, const char* lpszLocalHost);

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

Data Type

String

NamespaceCount Property (Atom Class)

The number of records in the Namespace arrays.

Syntax

ANSI (Cross Platform)
int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount); Unicode (Windows) INT GetNamespaceCount();
INT SetNamespaceCount(INT iNamespaceCount);
@property (nonatomic,readwrite,assign,getter=namespaceCount,setter=setNamespaceCount:) int namespaceCount;

- (int)namespaceCount;
- (void)setNamespaceCount:(int)newNamespaceCount;
int ipworks_atom_getnamespacecount(void* lpObj);
int ipworks_atom_setnamespacecount(void* lpObj, int iNamespaceCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (Atom Class)

The Prefix for the Namespace .

Syntax

ANSI (Cross Platform)
char* GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, const char* lpszNamespacePrefix); Unicode (Windows) LPWSTR GetNamespacePrefix(INT iNamespaceIndex);
INT SetNamespacePrefix(INT iNamespaceIndex, LPCWSTR lpszNamespacePrefix);
- (NSString*)namespacePrefix:(int)namespaceIndex;
- (void)setNamespacePrefix:(int)namespaceIndex:(NSString*)newNamespacePrefix;
char* ipworks_atom_getnamespaceprefix(void* lpObj, int namespaceindex);
int ipworks_atom_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

Default Value

""

Remarks

The NamespacePrefix for the Namespace.

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

This property is not available at design time.

Data Type

String

NamespaceURI Property (Atom Class)

Namespace URI associated with the corresponding Prefix .

Syntax

ANSI (Cross Platform)
char* GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, const char* lpszNamespaceURI); Unicode (Windows) LPWSTR GetNamespaceURI(INT iNamespaceIndex);
INT SetNamespaceURI(INT iNamespaceIndex, LPCWSTR lpszNamespaceURI);
- (NSString*)namespaceURI:(int)namespaceIndex;
- (void)setNamespaceURI:(int)namespaceIndex:(NSString*)newNamespaceURI;
char* ipworks_atom_getnamespaceuri(void* lpObj, int namespaceindex);
int ipworks_atom_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

OtherHeaders Property (Atom Class)

Other headers as determined by the user (optional).

Syntax

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders:(NSString*)newOtherHeaders;
char* ipworks_atom_getotherheaders(void* lpObj);
int ipworks_atom_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (Atom Class)

The number of records in the ParsedHeader arrays.

Syntax

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();
@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount;

- (int)parsedHeaderCount;
int ipworks_atom_getparsedheadercount(void* lpObj);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

ParsedHeaderField Property (Atom Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);
- (NSString*)parsedHeaderField:(int)parsedHeaderIndex;
char* ipworks_atom_getparsedheaderfield(void* lpObj, int parsedheaderindex);

Default Value

""

Remarks

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

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

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

Data Type

String

ParsedHeaderValue Property (Atom Class)

This property contains the header contents.

Syntax

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

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);
- (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;
char* ipworks_atom_getparsedheadervalue(void* lpObj, int parsedheaderindex);

Default Value

""

Remarks

This property contains the Header contents.

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

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

Data Type

String

Password Property (Atom Class)

A password if authentication is to be used.

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword:(NSString*)newPassword;
char* ipworks_atom_getpassword(void* lpObj);
int ipworks_atom_setpassword(void* lpObj, const char* lpszPassword);

Default Value

""

Remarks

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

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

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

Data Type

String

ProxyAuthScheme Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme:(int)newProxyAuthScheme;

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int ipworks_atom_getproxyauthscheme(void* lpObj);
int ipworks_atom_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is only used when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect:(BOOL)newProxyAutoDetect;
int ipworks_atom_getproxyautodetect(void* lpObj);
int ipworks_atom_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword:(NSString*)newProxyPassword;
char* ipworks_atom_getproxypassword(void* lpObj);
int ipworks_atom_setproxypassword(void* lpObj, const char* lpszProxyPassword);

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort:(int)newProxyPort;
int ipworks_atom_getproxyport(void* lpObj);
int ipworks_atom_setproxyport(void* lpObj, int iProxyPort);

Default Value

80

Remarks

This property contains the TCP port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer:(NSString*)newProxyServer;
char* ipworks_atom_getproxyserver(void* lpObj);
int ipworks_atom_setproxyserver(void* lpObj, const char* lpszProxyServer);

Default Value

""

Remarks

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

If the ProxyServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (Atom Class)

This property determines when to use SSL for the connection to the proxy.

Syntax

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

Possible Values

PS_AUTOMATIC(0), 
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL:(int)newProxySSL;

Possible Values

PS_AUTOMATIC(0), 
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int ipworks_atom_getproxyssl(void* lpObj);
int ipworks_atom_setproxyssl(void* lpObj, int iProxySSL);

Default Value

0

Remarks

This property determines when to use SSL for the connection to the proxy. The applicable values are the following:

psAutomatic (0)Default setting. If the URL is an "https" URL, the class will use the psTunnel option. If the URL is a "http" URL, the class will use the psNever option.
psAlways (1)The connection is always SSL-enabled.
psNever (2)The connection is not SSL-enabled.
psTunnel (3)The connection is through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (Atom Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser:(NSString*)newProxyUser;
char* ipworks_atom_getproxyuser(void* lpObj);
int ipworks_atom_setproxyuser(void* lpObj, const char* lpszProxyUser);

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Referer Property (Atom Class)

Referer URL/document (optional).

Syntax

ANSI (Cross Platform)
char* GetReferer();
int SetReferer(const char* lpszReferer); Unicode (Windows) LPWSTR GetReferer();
INT SetReferer(LPCWSTR lpszReferer);
@property (nonatomic,readwrite,assign,getter=referer,setter=setReferer:) NSString* referer;

- (NSString*)referer;
- (void)setReferer:(NSString*)newReferer;
char* ipworks_atom_getreferer(void* lpObj);
int ipworks_atom_setreferer(void* lpObj, const char* lpszReferer);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

Slug Property (Atom Class)

A header added to the HTTP request.

Syntax

ANSI (Cross Platform)
char* GetSlug();
int SetSlug(const char* lpszSlug); Unicode (Windows) LPWSTR GetSlug();
INT SetSlug(LPCWSTR lpszSlug);
@property (nonatomic,readwrite,assign,getter=slug,setter=setSlug:) NSString* slug;

- (NSString*)slug;
- (void)setSlug:(NSString*)newSlug;
char* ipworks_atom_getslug(void* lpObj);
int ipworks_atom_setslug(void* lpObj, const char* lpszSlug);

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertEncoded Property (Atom Class)

This is the certificate (PEM/base64 encoded).

Syntax

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);
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded:(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB:(NSData*)newSSLAcceptServerCertEncoded;
int ipworks_atom_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_atom_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (Atom Class)

This is the certificate (PEM/base64 encoded).

Syntax

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);
@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded:(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB:(NSData*)newSSLCertEncoded;
int ipworks_atom_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_atom_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (Atom Class)

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

Syntax

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);
@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore:(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB:(NSData*)newSSLCertStore;
int ipworks_atom_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_atom_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

SSLCertStorePassword Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword:(NSString*)newSSLCertStorePassword;
char* ipworks_atom_getsslcertstorepassword(void* lpObj);
int ipworks_atom_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (Atom Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

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_AUTO(99)
@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType:(int)newSSLCertStoreType;

Possible Values

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_AUTO(99)
int ipworks_atom_getsslcertstoretype(void* lpObj);
int ipworks_atom_setsslcertstoretype(void* lpObj, 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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject:(NSString*)newSSLCertSubject;
char* ipworks_atom_getsslcertsubject(void* lpObj);
int ipworks_atom_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (Atom Class)

TBD.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider:(int)newSSLProvider;

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworks_atom_getsslprovider(void* lpObj);
int ipworks_atom_setsslprovider(void* lpObj, int iSSLProvider);

Default Value

0

Remarks

TBD.

Data Type

Integer

SSLServerCertEncoded Property (Atom Class)

This is the certificate (PEM/base64 encoded).

Syntax

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

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
int ipworks_atom_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (Atom Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout:(int)newTimeout;
int ipworks_atom_gettimeout(void* lpObj);
int ipworks_atom_settimeout(void* lpObj, int iTimeout);

Default Value

60

Remarks

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

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (Atom Class)

The contents of the last response from the server.

Syntax

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

Unicode (Windows)
INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);
@property (nonatomic,readonly,assign,getter=transferredData) NSString* transferredData;

- (NSString*)transferredData;

@property (nonatomic,readonly,assign,getter=transferredDataB) NSData* transferredDataB; - (NSData*)transferredDataB;
int ipworks_atom_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);

Default Value

""

Remarks

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

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

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

Data Type

Binary String

TransferredDataLimit Property (Atom Class)

The maximum of bytes of data to be transferred.

Syntax

ANSI (Cross Platform)
int64 GetTransferredDataLimit();
int SetTransferredDataLimit(int64 lTransferredDataLimit); Unicode (Windows) LONG64 GetTransferredDataLimit();
INT SetTransferredDataLimit(LONG64 lTransferredDataLimit);
@property (nonatomic,readwrite,assign,getter=transferredDataLimit,setter=setTransferredDataLimit:) long long transferredDataLimit;

- (long long)transferredDataLimit;
- (void)setTransferredDataLimit:(long long)newTransferredDataLimit;
int64 ipworks_atom_gettransferreddatalimit(void* lpObj);
int ipworks_atom_settransferreddatalimit(void* lpObj, int64 lTransferredDataLimit);

Default Value

0

Remarks

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

Data Type

Long64

TransferredHeaders Property (Atom Class)

The full set of headers as received from the server.

Syntax

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();
@property (nonatomic,readonly,assign,getter=transferredHeaders) NSString* transferredHeaders;

- (NSString*)transferredHeaders;
char* ipworks_atom_gettransferredheaders(void* lpObj);

Default Value

""

Remarks

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

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

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

Data Type

String

UpdateEntryAuthorEmail Property (Atom Class)

This property contains the email address of the author.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryAuthorEmail();
int SetUpdateEntryAuthorEmail(const char* lpszUpdateEntryAuthorEmail); Unicode (Windows) LPWSTR GetUpdateEntryAuthorEmail();
INT SetUpdateEntryAuthorEmail(LPCWSTR lpszUpdateEntryAuthorEmail);
@property (nonatomic,readwrite,assign,getter=updateEntryAuthorEmail,setter=setUpdateEntryAuthorEmail:) NSString* updateEntryAuthorEmail;

- (NSString*)updateEntryAuthorEmail;
- (void)setUpdateEntryAuthorEmail:(NSString*)newUpdateEntryAuthorEmail;
char* ipworks_atom_getupdateentryauthoremail(void* lpObj);
int ipworks_atom_setupdateentryauthoremail(void* lpObj, const char* lpszUpdateEntryAuthorEmail);

Default Value

""

Remarks

This property contains the email address of the author.

This property is not available at design time.

Data Type

String

UpdateEntryAuthorName Property (Atom Class)

This property contains the name of the author.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryAuthorName();
int SetUpdateEntryAuthorName(const char* lpszUpdateEntryAuthorName); Unicode (Windows) LPWSTR GetUpdateEntryAuthorName();
INT SetUpdateEntryAuthorName(LPCWSTR lpszUpdateEntryAuthorName);
@property (nonatomic,readwrite,assign,getter=updateEntryAuthorName,setter=setUpdateEntryAuthorName:) NSString* updateEntryAuthorName;

- (NSString*)updateEntryAuthorName;
- (void)setUpdateEntryAuthorName:(NSString*)newUpdateEntryAuthorName;
char* ipworks_atom_getupdateentryauthorname(void* lpObj);
int ipworks_atom_setupdateentryauthorname(void* lpObj, const char* lpszUpdateEntryAuthorName);

Default Value

""

Remarks

This property contains the name of the author.

This property is not available at design time.

Data Type

String

UpdateEntryAuthorUri Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryAuthorUri();
int SetUpdateEntryAuthorUri(const char* lpszUpdateEntryAuthorUri); Unicode (Windows) LPWSTR GetUpdateEntryAuthorUri();
INT SetUpdateEntryAuthorUri(LPCWSTR lpszUpdateEntryAuthorUri);
@property (nonatomic,readwrite,assign,getter=updateEntryAuthorUri,setter=setUpdateEntryAuthorUri:) NSString* updateEntryAuthorUri;

- (NSString*)updateEntryAuthorUri;
- (void)setUpdateEntryAuthorUri:(NSString*)newUpdateEntryAuthorUri;
char* ipworks_atom_getupdateentryauthoruri(void* lpObj);
int ipworks_atom_setupdateentryauthoruri(void* lpObj, const char* lpszUpdateEntryAuthorUri);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryCategoryLabel Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryCategoryLabel();
int SetUpdateEntryCategoryLabel(const char* lpszUpdateEntryCategoryLabel); Unicode (Windows) LPWSTR GetUpdateEntryCategoryLabel();
INT SetUpdateEntryCategoryLabel(LPCWSTR lpszUpdateEntryCategoryLabel);
@property (nonatomic,readwrite,assign,getter=updateEntryCategoryLabel,setter=setUpdateEntryCategoryLabel:) NSString* updateEntryCategoryLabel;

- (NSString*)updateEntryCategoryLabel;
- (void)setUpdateEntryCategoryLabel:(NSString*)newUpdateEntryCategoryLabel;
char* ipworks_atom_getupdateentrycategorylabel(void* lpObj);
int ipworks_atom_setupdateentrycategorylabel(void* lpObj, const char* lpszUpdateEntryCategoryLabel);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryCategoryScheme Property (Atom Class)

This property identifies a categorization scheme.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryCategoryScheme();
int SetUpdateEntryCategoryScheme(const char* lpszUpdateEntryCategoryScheme); Unicode (Windows) LPWSTR GetUpdateEntryCategoryScheme();
INT SetUpdateEntryCategoryScheme(LPCWSTR lpszUpdateEntryCategoryScheme);
@property (nonatomic,readwrite,assign,getter=updateEntryCategoryScheme,setter=setUpdateEntryCategoryScheme:) NSString* updateEntryCategoryScheme;

- (NSString*)updateEntryCategoryScheme;
- (void)setUpdateEntryCategoryScheme:(NSString*)newUpdateEntryCategoryScheme;
char* ipworks_atom_getupdateentrycategoryscheme(void* lpObj);
int ipworks_atom_setupdateentrycategoryscheme(void* lpObj, const char* lpszUpdateEntryCategoryScheme);

Default Value

""

Remarks

This property identifies a categorization scheme.

This property is not available at design time.

Data Type

String

UpdateEntryCategoryTerm Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryCategoryTerm();
int SetUpdateEntryCategoryTerm(const char* lpszUpdateEntryCategoryTerm); Unicode (Windows) LPWSTR GetUpdateEntryCategoryTerm();
INT SetUpdateEntryCategoryTerm(LPCWSTR lpszUpdateEntryCategoryTerm);
@property (nonatomic,readwrite,assign,getter=updateEntryCategoryTerm,setter=setUpdateEntryCategoryTerm:) NSString* updateEntryCategoryTerm;

- (NSString*)updateEntryCategoryTerm;
- (void)setUpdateEntryCategoryTerm:(NSString*)newUpdateEntryCategoryTerm;
char* ipworks_atom_getupdateentrycategoryterm(void* lpObj);
int ipworks_atom_setupdateentrycategoryterm(void* lpObj, const char* lpszUpdateEntryCategoryTerm);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryContent Property (Atom Class)

This property contains the text contents of an Atom entry.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryContent();
int SetUpdateEntryContent(const char* lpszUpdateEntryContent); Unicode (Windows) LPWSTR GetUpdateEntryContent();
INT SetUpdateEntryContent(LPCWSTR lpszUpdateEntryContent);
@property (nonatomic,readwrite,assign,getter=updateEntryContent,setter=setUpdateEntryContent:) NSString* updateEntryContent;

- (NSString*)updateEntryContent;
- (void)setUpdateEntryContent:(NSString*)newUpdateEntryContent;
char* ipworks_atom_getupdateentrycontent(void* lpObj);
int ipworks_atom_setupdateentrycontent(void* lpObj, const char* lpszUpdateEntryContent);

Default Value

""

Remarks

This property contains the text contents of an Atom entry.

Data Type

String

UpdateEntryContentTextType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetUpdateEntryContentTextType();
int SetUpdateEntryContentTextType(int iUpdateEntryContentTextType); Unicode (Windows) INT GetUpdateEntryContentTextType();
INT SetUpdateEntryContentTextType(INT iUpdateEntryContentTextType);

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
@property (nonatomic,readwrite,assign,getter=updateEntryContentTextType,setter=setUpdateEntryContentTextType:) int updateEntryContentTextType;

- (int)updateEntryContentTextType;
- (void)setUpdateEntryContentTextType:(int)newUpdateEntryContentTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getupdateentrycontenttexttype(void* lpObj);
int ipworks_atom_setupdateentrycontenttexttype(void* lpObj, int iUpdateEntryContentTextType);

Default Value

0

Remarks

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

Data Type

Integer

UpdateEntryContributorEmail Property (Atom Class)

This property contains the email address of the contributor.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryContributorEmail();
int SetUpdateEntryContributorEmail(const char* lpszUpdateEntryContributorEmail); Unicode (Windows) LPWSTR GetUpdateEntryContributorEmail();
INT SetUpdateEntryContributorEmail(LPCWSTR lpszUpdateEntryContributorEmail);
@property (nonatomic,readwrite,assign,getter=updateEntryContributorEmail,setter=setUpdateEntryContributorEmail:) NSString* updateEntryContributorEmail;

- (NSString*)updateEntryContributorEmail;
- (void)setUpdateEntryContributorEmail:(NSString*)newUpdateEntryContributorEmail;
char* ipworks_atom_getupdateentrycontributoremail(void* lpObj);
int ipworks_atom_setupdateentrycontributoremail(void* lpObj, const char* lpszUpdateEntryContributorEmail);

Default Value

""

Remarks

This property contains the email address of the contributor.

This property is not available at design time.

Data Type

String

UpdateEntryContributorName Property (Atom Class)

This property contains the name of the contributor.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryContributorName();
int SetUpdateEntryContributorName(const char* lpszUpdateEntryContributorName); Unicode (Windows) LPWSTR GetUpdateEntryContributorName();
INT SetUpdateEntryContributorName(LPCWSTR lpszUpdateEntryContributorName);
@property (nonatomic,readwrite,assign,getter=updateEntryContributorName,setter=setUpdateEntryContributorName:) NSString* updateEntryContributorName;

- (NSString*)updateEntryContributorName;
- (void)setUpdateEntryContributorName:(NSString*)newUpdateEntryContributorName;
char* ipworks_atom_getupdateentrycontributorname(void* lpObj);
int ipworks_atom_setupdateentrycontributorname(void* lpObj, const char* lpszUpdateEntryContributorName);

Default Value

""

Remarks

This property contains the name of the contributor.

This property is not available at design time.

Data Type

String

UpdateEntryContributorUri Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryContributorUri();
int SetUpdateEntryContributorUri(const char* lpszUpdateEntryContributorUri); Unicode (Windows) LPWSTR GetUpdateEntryContributorUri();
INT SetUpdateEntryContributorUri(LPCWSTR lpszUpdateEntryContributorUri);
@property (nonatomic,readwrite,assign,getter=updateEntryContributorUri,setter=setUpdateEntryContributorUri:) NSString* updateEntryContributorUri;

- (NSString*)updateEntryContributorUri;
- (void)setUpdateEntryContributorUri:(NSString*)newUpdateEntryContributorUri;
char* ipworks_atom_getupdateentrycontributoruri(void* lpObj);
int ipworks_atom_setupdateentrycontributoruri(void* lpObj, const char* lpszUpdateEntryContributorUri);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryCopyright Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryCopyright();
int SetUpdateEntryCopyright(const char* lpszUpdateEntryCopyright); Unicode (Windows) LPWSTR GetUpdateEntryCopyright();
INT SetUpdateEntryCopyright(LPCWSTR lpszUpdateEntryCopyright);
@property (nonatomic,readwrite,assign,getter=updateEntryCopyright,setter=setUpdateEntryCopyright:) NSString* updateEntryCopyright;

- (NSString*)updateEntryCopyright;
- (void)setUpdateEntryCopyright:(NSString*)newUpdateEntryCopyright;
char* ipworks_atom_getupdateentrycopyright(void* lpObj);
int ipworks_atom_setupdateentrycopyright(void* lpObj, const char* lpszUpdateEntryCopyright);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryCreated Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryCreated();
int SetUpdateEntryCreated(const char* lpszUpdateEntryCreated); Unicode (Windows) LPWSTR GetUpdateEntryCreated();
INT SetUpdateEntryCreated(LPCWSTR lpszUpdateEntryCreated);
@property (nonatomic,readwrite,assign,getter=updateEntryCreated,setter=setUpdateEntryCreated:) NSString* updateEntryCreated;

- (NSString*)updateEntryCreated;
- (void)setUpdateEntryCreated:(NSString*)newUpdateEntryCreated;
char* ipworks_atom_getupdateentrycreated(void* lpObj);
int ipworks_atom_setupdateentrycreated(void* lpObj, const char* lpszUpdateEntryCreated);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryXML Property (Atom Class)

This property contains the full XML contents of the entry.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryXML();
int SetUpdateEntryXML(const char* lpszUpdateEntryXML); Unicode (Windows) LPWSTR GetUpdateEntryXML();
INT SetUpdateEntryXML(LPCWSTR lpszUpdateEntryXML);
@property (nonatomic,readwrite,assign,getter=updateEntryXML,setter=setUpdateEntryXML:) NSString* updateEntryXML;

- (NSString*)updateEntryXML;
- (void)setUpdateEntryXML:(NSString*)newUpdateEntryXML;
char* ipworks_atom_getupdateentryxml(void* lpObj);
int ipworks_atom_setupdateentryxml(void* lpObj, const char* lpszUpdateEntryXML);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

UpdateEntryId Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryId();
int SetUpdateEntryId(const char* lpszUpdateEntryId); Unicode (Windows) LPWSTR GetUpdateEntryId();
INT SetUpdateEntryId(LPCWSTR lpszUpdateEntryId);
@property (nonatomic,readwrite,assign,getter=updateEntryId,setter=setUpdateEntryId:) NSString* updateEntryId;

- (NSString*)updateEntryId;
- (void)setUpdateEntryId:(NSString*)newUpdateEntryId;
char* ipworks_atom_getupdateentryid(void* lpObj);
int ipworks_atom_setupdateentryid(void* lpObj, const char* lpszUpdateEntryId);

Default Value

""

Remarks

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

Data Type

String

UpdateEntryIssued Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryIssued();
int SetUpdateEntryIssued(const char* lpszUpdateEntryIssued); Unicode (Windows) LPWSTR GetUpdateEntryIssued();
INT SetUpdateEntryIssued(LPCWSTR lpszUpdateEntryIssued);
@property (nonatomic,readwrite,assign,getter=updateEntryIssued,setter=setUpdateEntryIssued:) NSString* updateEntryIssued;

- (NSString*)updateEntryIssued;
- (void)setUpdateEntryIssued:(NSString*)newUpdateEntryIssued;
char* ipworks_atom_getupdateentryissued(void* lpObj);
int ipworks_atom_setupdateentryissued(void* lpObj, const char* lpszUpdateEntryIssued);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryLinkHref Property (Atom Class)

This property contains the location of the link.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryLinkHref();
int SetUpdateEntryLinkHref(const char* lpszUpdateEntryLinkHref); Unicode (Windows) LPWSTR GetUpdateEntryLinkHref();
INT SetUpdateEntryLinkHref(LPCWSTR lpszUpdateEntryLinkHref);
@property (nonatomic,readwrite,assign,getter=updateEntryLinkHref,setter=setUpdateEntryLinkHref:) NSString* updateEntryLinkHref;

- (NSString*)updateEntryLinkHref;
- (void)setUpdateEntryLinkHref:(NSString*)newUpdateEntryLinkHref;
char* ipworks_atom_getupdateentrylinkhref(void* lpObj);
int ipworks_atom_setupdateentrylinkhref(void* lpObj, const char* lpszUpdateEntryLinkHref);

Default Value

""

Remarks

This property contains the location of the link.

This property is not available at design time.

Data Type

String

UpdateEntryLinkHrefLang Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryLinkHrefLang();
int SetUpdateEntryLinkHrefLang(const char* lpszUpdateEntryLinkHrefLang); Unicode (Windows) LPWSTR GetUpdateEntryLinkHrefLang();
INT SetUpdateEntryLinkHrefLang(LPCWSTR lpszUpdateEntryLinkHrefLang);
@property (nonatomic,readwrite,assign,getter=updateEntryLinkHrefLang,setter=setUpdateEntryLinkHrefLang:) NSString* updateEntryLinkHrefLang;

- (NSString*)updateEntryLinkHrefLang;
- (void)setUpdateEntryLinkHrefLang:(NSString*)newUpdateEntryLinkHrefLang;
char* ipworks_atom_getupdateentrylinkhreflang(void* lpObj);
int ipworks_atom_setupdateentrylinkhreflang(void* lpObj, const char* lpszUpdateEntryLinkHrefLang);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryLinkLength Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryLinkLength();
int SetUpdateEntryLinkLength(const char* lpszUpdateEntryLinkLength); Unicode (Windows) LPWSTR GetUpdateEntryLinkLength();
INT SetUpdateEntryLinkLength(LPCWSTR lpszUpdateEntryLinkLength);
@property (nonatomic,readwrite,assign,getter=updateEntryLinkLength,setter=setUpdateEntryLinkLength:) NSString* updateEntryLinkLength;

- (NSString*)updateEntryLinkLength;
- (void)setUpdateEntryLinkLength:(NSString*)newUpdateEntryLinkLength;
char* ipworks_atom_getupdateentrylinklength(void* lpObj);
int ipworks_atom_setupdateentrylinklength(void* lpObj, const char* lpszUpdateEntryLinkLength);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryLinkRel Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryLinkRel();
int SetUpdateEntryLinkRel(const char* lpszUpdateEntryLinkRel); Unicode (Windows) LPWSTR GetUpdateEntryLinkRel();
INT SetUpdateEntryLinkRel(LPCWSTR lpszUpdateEntryLinkRel);
@property (nonatomic,readwrite,assign,getter=updateEntryLinkRel,setter=setUpdateEntryLinkRel:) NSString* updateEntryLinkRel;

- (NSString*)updateEntryLinkRel;
- (void)setUpdateEntryLinkRel:(NSString*)newUpdateEntryLinkRel;
char* ipworks_atom_getupdateentrylinkrel(void* lpObj);
int ipworks_atom_setupdateentrylinkrel(void* lpObj, const char* lpszUpdateEntryLinkRel);

Default Value

""

Remarks

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

  • alternate
  • related
  • self
  • enclosure
  • via

This property is not available at design time.

Data Type

String

UpdateEntryLinkTitle Property (Atom Class)

This property contains the title of the link.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryLinkTitle();
int SetUpdateEntryLinkTitle(const char* lpszUpdateEntryLinkTitle); Unicode (Windows) LPWSTR GetUpdateEntryLinkTitle();
INT SetUpdateEntryLinkTitle(LPCWSTR lpszUpdateEntryLinkTitle);
@property (nonatomic,readwrite,assign,getter=updateEntryLinkTitle,setter=setUpdateEntryLinkTitle:) NSString* updateEntryLinkTitle;

- (NSString*)updateEntryLinkTitle;
- (void)setUpdateEntryLinkTitle:(NSString*)newUpdateEntryLinkTitle;
char* ipworks_atom_getupdateentrylinktitle(void* lpObj);
int ipworks_atom_setupdateentrylinktitle(void* lpObj, const char* lpszUpdateEntryLinkTitle);

Default Value

""

Remarks

This property contains the title of the link.

This property is not available at design time.

Data Type

String

UpdateEntryLinkType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryLinkType();
int SetUpdateEntryLinkType(const char* lpszUpdateEntryLinkType); Unicode (Windows) LPWSTR GetUpdateEntryLinkType();
INT SetUpdateEntryLinkType(LPCWSTR lpszUpdateEntryLinkType);
@property (nonatomic,readwrite,assign,getter=updateEntryLinkType,setter=setUpdateEntryLinkType:) NSString* updateEntryLinkType;

- (NSString*)updateEntryLinkType;
- (void)setUpdateEntryLinkType:(NSString*)newUpdateEntryLinkType;
char* ipworks_atom_getupdateentrylinktype(void* lpObj);
int ipworks_atom_setupdateentrylinktype(void* lpObj, const char* lpszUpdateEntryLinkType);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryModified Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryModified();
int SetUpdateEntryModified(const char* lpszUpdateEntryModified); Unicode (Windows) LPWSTR GetUpdateEntryModified();
INT SetUpdateEntryModified(LPCWSTR lpszUpdateEntryModified);
@property (nonatomic,readwrite,assign,getter=updateEntryModified,setter=setUpdateEntryModified:) NSString* updateEntryModified;

- (NSString*)updateEntryModified;
- (void)setUpdateEntryModified:(NSString*)newUpdateEntryModified;
char* ipworks_atom_getupdateentrymodified(void* lpObj);
int ipworks_atom_setupdateentrymodified(void* lpObj, const char* lpszUpdateEntryModified);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

UpdateEntryPublished Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryPublished();
int SetUpdateEntryPublished(const char* lpszUpdateEntryPublished); Unicode (Windows) LPWSTR GetUpdateEntryPublished();
INT SetUpdateEntryPublished(LPCWSTR lpszUpdateEntryPublished);
@property (nonatomic,readwrite,assign,getter=updateEntryPublished,setter=setUpdateEntryPublished:) NSString* updateEntryPublished;

- (NSString*)updateEntryPublished;
- (void)setUpdateEntryPublished:(NSString*)newUpdateEntryPublished;
char* ipworks_atom_getupdateentrypublished(void* lpObj);
int ipworks_atom_setupdateentrypublished(void* lpObj, const char* lpszUpdateEntryPublished);

Default Value

""

Remarks

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

Data Type

String

UpdateEntryRights Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryRights();
int SetUpdateEntryRights(const char* lpszUpdateEntryRights); Unicode (Windows) LPWSTR GetUpdateEntryRights();
INT SetUpdateEntryRights(LPCWSTR lpszUpdateEntryRights);
@property (nonatomic,readwrite,assign,getter=updateEntryRights,setter=setUpdateEntryRights:) NSString* updateEntryRights;

- (NSString*)updateEntryRights;
- (void)setUpdateEntryRights:(NSString*)newUpdateEntryRights;
char* ipworks_atom_getupdateentryrights(void* lpObj);
int ipworks_atom_setupdateentryrights(void* lpObj, const char* lpszUpdateEntryRights);

Default Value

""

Remarks

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

Data Type

String

UpdateEntryRightsTextType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetUpdateEntryRightsTextType();
int SetUpdateEntryRightsTextType(int iUpdateEntryRightsTextType); Unicode (Windows) INT GetUpdateEntryRightsTextType();
INT SetUpdateEntryRightsTextType(INT iUpdateEntryRightsTextType);

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
@property (nonatomic,readwrite,assign,getter=updateEntryRightsTextType,setter=setUpdateEntryRightsTextType:) int updateEntryRightsTextType;

- (int)updateEntryRightsTextType;
- (void)setUpdateEntryRightsTextType:(int)newUpdateEntryRightsTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getupdateentryrightstexttype(void* lpObj);
int ipworks_atom_setupdateentryrightstexttype(void* lpObj, int iUpdateEntryRightsTextType);

Default Value

0

Remarks

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

Data Type

Integer

UpdateEntrySource Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntrySource();
int SetUpdateEntrySource(const char* lpszUpdateEntrySource); Unicode (Windows) LPWSTR GetUpdateEntrySource();
INT SetUpdateEntrySource(LPCWSTR lpszUpdateEntrySource);
@property (nonatomic,readwrite,assign,getter=updateEntrySource,setter=setUpdateEntrySource:) NSString* updateEntrySource;

- (NSString*)updateEntrySource;
- (void)setUpdateEntrySource:(NSString*)newUpdateEntrySource;
char* ipworks_atom_getupdateentrysource(void* lpObj);
int ipworks_atom_setupdateentrysource(void* lpObj, const char* lpszUpdateEntrySource);

Default Value

""

Remarks

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

Data Type

String

UpdateEntrySummary Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntrySummary();
int SetUpdateEntrySummary(const char* lpszUpdateEntrySummary); Unicode (Windows) LPWSTR GetUpdateEntrySummary();
INT SetUpdateEntrySummary(LPCWSTR lpszUpdateEntrySummary);
@property (nonatomic,readwrite,assign,getter=updateEntrySummary,setter=setUpdateEntrySummary:) NSString* updateEntrySummary;

- (NSString*)updateEntrySummary;
- (void)setUpdateEntrySummary:(NSString*)newUpdateEntrySummary;
char* ipworks_atom_getupdateentrysummary(void* lpObj);
int ipworks_atom_setupdateentrysummary(void* lpObj, const char* lpszUpdateEntrySummary);

Default Value

""

Remarks

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

Data Type

String

UpdateEntrySummaryTextType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetUpdateEntrySummaryTextType();
int SetUpdateEntrySummaryTextType(int iUpdateEntrySummaryTextType); Unicode (Windows) INT GetUpdateEntrySummaryTextType();
INT SetUpdateEntrySummaryTextType(INT iUpdateEntrySummaryTextType);

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
@property (nonatomic,readwrite,assign,getter=updateEntrySummaryTextType,setter=setUpdateEntrySummaryTextType:) int updateEntrySummaryTextType;

- (int)updateEntrySummaryTextType;
- (void)setUpdateEntrySummaryTextType:(int)newUpdateEntrySummaryTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getupdateentrysummarytexttype(void* lpObj);
int ipworks_atom_setupdateentrysummarytexttype(void* lpObj, int iUpdateEntrySummaryTextType);

Default Value

0

Remarks

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

Data Type

Integer

UpdateEntryTitle Property (Atom Class)

This property contains the title of the current Atom Feed.

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryTitle();
int SetUpdateEntryTitle(const char* lpszUpdateEntryTitle); Unicode (Windows) LPWSTR GetUpdateEntryTitle();
INT SetUpdateEntryTitle(LPCWSTR lpszUpdateEntryTitle);
@property (nonatomic,readwrite,assign,getter=updateEntryTitle,setter=setUpdateEntryTitle:) NSString* updateEntryTitle;

- (NSString*)updateEntryTitle;
- (void)setUpdateEntryTitle:(NSString*)newUpdateEntryTitle;
char* ipworks_atom_getupdateentrytitle(void* lpObj);
int ipworks_atom_setupdateentrytitle(void* lpObj, const char* lpszUpdateEntryTitle);

Default Value

""

Remarks

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

Data Type

String

UpdateEntryTitleTextType Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
int GetUpdateEntryTitleTextType();
int SetUpdateEntryTitleTextType(int iUpdateEntryTitleTextType); Unicode (Windows) INT GetUpdateEntryTitleTextType();
INT SetUpdateEntryTitleTextType(INT iUpdateEntryTitleTextType);

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
@property (nonatomic,readwrite,assign,getter=updateEntryTitleTextType,setter=setUpdateEntryTitleTextType:) int updateEntryTitleTextType;

- (int)updateEntryTitleTextType;
- (void)setUpdateEntryTitleTextType:(int)newUpdateEntryTitleTextType;

Possible Values

TT_TEXT(0), 
TT_HTML(1),
TT_XHTML(2)
int ipworks_atom_getupdateentrytitletexttype(void* lpObj);
int ipworks_atom_setupdateentrytitletexttype(void* lpObj, int iUpdateEntryTitleTextType);

Default Value

0

Remarks

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

Data Type

Integer

UpdateEntryUpdated Property (Atom Class)

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

Syntax

ANSI (Cross Platform)
char* GetUpdateEntryUpdated();
int SetUpdateEntryUpdated(const char* lpszUpdateEntryUpdated); Unicode (Windows) LPWSTR GetUpdateEntryUpdated();
INT SetUpdateEntryUpdated(LPCWSTR lpszUpdateEntryUpdated);
@property (nonatomic,readwrite,assign,getter=updateEntryUpdated,setter=setUpdateEntryUpdated:) NSString* updateEntryUpdated;

- (NSString*)updateEntryUpdated;
- (void)setUpdateEntryUpdated:(NSString*)newUpdateEntryUpdated;
char* ipworks_atom_getupdateentryupdated(void* lpObj);
int ipworks_atom_setupdateentryupdated(void* lpObj, const char* lpszUpdateEntryUpdated);

Default Value

""

Remarks

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

Data Type

String

UpdateFile Property (Atom Class)

This is a resource to be updated, deleted, or created.

Syntax

ANSI (Cross Platform)
char* GetUpdateFile();
int SetUpdateFile(const char* lpszUpdateFile); Unicode (Windows) LPWSTR GetUpdateFile();
INT SetUpdateFile(LPCWSTR lpszUpdateFile);
@property (nonatomic,readwrite,assign,getter=updateFile,setter=setUpdateFile:) NSString* updateFile;

- (NSString*)updateFile;
- (void)setUpdateFile:(NSString*)newUpdateFile;
char* ipworks_atom_getupdatefile(void* lpObj);
int ipworks_atom_setupdatefile(void* lpObj, const char* lpszUpdateFile);

Default Value

""

Remarks

This property allows you to create, update, and delete Atom resources using the Put method.

If UpdateFile is set to a local file, the content of that file will be used to form the content of the HTTP request.

Data Type

String

User Property (Atom Class)

A user name if authentication is to be used.

Syntax

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser); Unicode (Windows) LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);
@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser:(NSString*)newUser;
char* ipworks_atom_getuser(void* lpObj);
int ipworks_atom_setuser(void* lpObj, const char* lpszUser);

Default Value

""

Remarks

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

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

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

Data Type

String

AddCookie Method (Atom Class)

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

Syntax

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

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);
- (void)addCookie:(NSString*)cookieName :(NSString*)cookieValue;
int ipworks_atom_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

Remarks

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

Error Handling (C++)

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

AddNamespace Method (Atom Class)

This method adds a namespace to the Namespaces properties.

Syntax

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

Unicode (Windows)
INT AddNamespace(LPCWSTR lpszPrefix, LPCWSTR lpszNamespaceURI);
- (void)addNamespace:(NSString*)prefix :(NSString*)namespaceURI;
int ipworks_atom_addnamespace(void* lpObj, const char* lpszPrefix, const char* lpszNamespaceURI);

Remarks

This method is used to add a namespace to the Namespaces properties. Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

Error Handling (C++)

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

Config Method (Atom Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
- (NSString*)config:(NSString*)configurationString;
char* ipworks_atom_config(void* lpObj, const char* lpszConfigurationString);

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.

DeleteResource Method (Atom Class)

This method deletes the resource at the specified URL.

Syntax

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

Unicode (Windows)
INT DeleteResource(LPCWSTR lpszURL);
- (void)deleteResource:(NSString*)URL;
int ipworks_atom_deleteresource(void* lpObj, const char* lpszURL);

Remarks

The class will delete a resource at the specified URL.

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

Processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
- (void)doEvents;
int ipworks_atom_doevents(void* lpObj);

Remarks

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

Error Handling (C++)

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

GetFeed Method (Atom Class)

This method fetches an Atom feed.

Syntax

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

Unicode (Windows)
INT GetFeed(LPCWSTR lpszURL);
- (void)getFeed:(NSString*)URL;
int ipworks_atom_getfeed(void* lpObj, const char* lpszURL);

Remarks

This method fetches the document. The document contents are delivered in the AtomData property, as well as through the Transfer event, and the HTTP response headers through the Header event.

Then the class will attempt to parse the Atom feed, filling in the Channel and Entries properties as it goes. The Channel properties also can be accessed using the GetProperty and SetProperty methods, if necessary.

Error Handling (C++)

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

GetProperty Method (Atom Class)

This method fetches the value of a specific Atom feed element or attribute.

Syntax

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

Unicode (Windows)
LPWSTR GetProperty(LPCWSTR lpszPropertyName);
- (NSString*)getProperty:(NSString*)propertyName;
char* ipworks_atom_getproperty(void* lpObj, const char* lpszPropertyName);

Remarks

This method is intended for extending functionality of the Atom class. It will fetch the value for a specific entry element or attribute of this Atom feed. Property is the XPath of the element or attribute according to the following convention: /feed/element@attribute or entry[x]/element@attribute. The @attribute part is optional.

entry[x] is the Channel's xth entry (or any other root-level child), where the indexer x starts at 1.

element is any child of the Channel or an entry, and attribute can be any attribute of that field. If an attribute is not supplied, the GetProperty method will return the text portion of element. For example:

AtomControl.GetProperty("entry[5]/link@href") AtomControl.GetProperty("entry[5]/author/name") AtomControl.GetProperty("/feed/title")

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

Error Handling (C++)

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

GetResource Method (Atom Class)

This method fetches a resource.

Syntax

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

Unicode (Windows)
INT GetResource(LPCWSTR lpszURL);
- (void)getResource:(NSString*)URL;
int ipworks_atom_getresource(void* lpObj, const char* lpszURL);

Remarks

This method fetches the resource. If LocalFile is set, the document will be saved in the specified file. Otherwise, the document contents are delivered in the AtomData property, as well as through the Transfer event, and the HTTP response headers are delivered through the Header event.

Unlike the GetFeed method, after retrieval, the class will not attempt to parse the data into the Channel and Entries properties.

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

Interrupt the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
- (void)interrupt;
int ipworks_atom_interrupt(void* lpObj);

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

PostResource Method (Atom Class)

This method posts a resource to the specified URL.

Syntax

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

Unicode (Windows)
INT PostResource(LPCWSTR lpszURL);
- (void)postResource:(NSString*)URL;
int ipworks_atom_postresource(void* lpObj, const char* lpszURL);

Remarks

This method will post a resource to the specified URL. It will either post a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry.

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

Put Method (Atom Class)

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

Syntax

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

Unicode (Windows)
INT Put(LPCWSTR lpszURL);
- (void)put:(NSString*)URL;
int ipworks_atom_put(void* lpObj, const char* lpszURL);

Remarks

This method will put a resource to the specified URL. It will either put a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry.

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

PutResource Method (Atom Class)

This method puts a resource to the specified URL.

Syntax

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

Unicode (Windows)
INT PutResource(LPCWSTR lpszURL);
- (void)putResource:(NSString*)URL;
int ipworks_atom_putresource(void* lpObj, const char* lpszURL);

Remarks

This method will put a resource to the specified URL. It will either put a media resource if UpdateFile is specified or an Atom entry if UpdateEntry is specified. UpdateFile takes precedence over UpdateEntry.

Error Handling (C++)

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

ReadFile Method (Atom Class)

This method loads an Atom file into the class.

Syntax

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

Unicode (Windows)
INT ReadFile(LPCWSTR lpszFileName);
- (void)readFile:(NSString*)fileName;
int ipworks_atom_readfile(void* lpObj, const char* lpszFileName);

Remarks

This method loads an Atom file and attempts to parse it, filling in the Channel and Entries properties as it goes. The Channel properties also can be accessed using the GetProperty and SetProperty methods if necessary.

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

This method resets all properties of the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
- (void)reset;
int ipworks_atom_reset(void* lpObj);

Remarks

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

Error Handling (C++)

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

SetProperty Method (Atom Class)

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

Syntax

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

Unicode (Windows)
INT SetProperty(LPCWSTR lpszPropertyName, LPCWSTR lpszPropertyValue);
- (void)setProperty:(NSString*)propertyName :(NSString*)propertyValue;
int ipworks_atom_setproperty(void* lpObj, const char* lpszPropertyName, const char* lpszPropertyValue);

Remarks

This method is intended for extending functionality of the Atom class. It will set the value for a specific field of this Atom feed. Property is the name of the property according to the following convention: root/element@attribute. The root field can be either of the two following values:

feedThis treats the channel as the root level, and element is any property of the channel. If an empty string ("") is supplied for the root field, the class will assume the channel is the root.
entry[x]This treats the channel's x-th entry as the root level. The field element is any property of an entry.

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

AtomControl.SetProperty("entry[5]/link@type", "text/html")

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

Error Handling (C++)

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

WriteFile Method (Atom Class)

This method is used to write an Atom feed from the class.

Syntax

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

Unicode (Windows)
INT WriteFile(LPCWSTR lpszFilename);
- (void)writeFile:(NSString*)filename;
int ipworks_atom_writefile(void* lpObj, const char* lpszFilename);

Remarks

This method will write an Atom feed from the existing property values to Filename. The Atom feed will be pre-verified, and if any missing required fields are encountered, the class fails with an error.

Example (Add an Item and Write)

AtomControl.EntryCount = 1 AtomControl.EntryContent(0) = "New Item Description" AtomControl.EntryLinkHref(0) = "http://itemurl" AtomControl.WriteFile(filename)

Error Handling (C++)

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

Connected Event (Atom Class)

Fired immediately after a connection completes (or fails).

Syntax

ANSI (Cross Platform)
virtual int FireConnected(AtomConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } AtomConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(AtomConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } AtomConnectedEventParams;
- (void)onConnected:(int)statusCode :(NSString*)description;
#define EID_ATOM_CONNECTED 1

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

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (Atom Class)

Fired to indicate changes in connection state.

Syntax

ANSI (Cross Platform)
virtual int FireConnectionStatus(AtomConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } AtomConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(AtomConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } AtomConnectionStatusEventParams;
- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;
#define EID_ATOM_CONNECTIONSTATUS 2

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

Remarks

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

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

Firewall connection complete.
SSL or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.

StatusCode has the error code returned by the TCP/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Disconnected Event (Atom Class)

Fired when a connection is closed.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnected(AtomDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } AtomDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(AtomDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } AtomDisconnectedEventParams;
- (void)onDisconnected:(int)statusCode :(NSString*)description;
#define EID_ATOM_DISCONNECTED 3

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

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the TCP/IP subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (Atom Class)

This event fires when a document finishes transferring.

Syntax

ANSI (Cross Platform)
virtual int FireEndTransfer(AtomEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } AtomEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(AtomEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } AtomEndTransferEventParams;
- (void)onEndTransfer:(int)direction;
#define EID_ATOM_ENDTRANSFER 4

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

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

Error Event (Atom Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(AtomErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } AtomErrorEventParams;
Unicode (Windows) virtual INT FireError(AtomErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } AtomErrorEventParams;
- (void)onError:(int)errorCode :(NSString*)description;
#define EID_ATOM_ERROR 5

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

Remarks

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

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

Header Event (Atom Class)

Fired every time a header line comes in.

Syntax

ANSI (Cross Platform)
virtual int FireHeader(AtomHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } AtomHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(AtomHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } AtomHeaderEventParams;
- (void)onHeader:(NSString*)field :(NSString*)value;
#define EID_ATOM_HEADER 6

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

Remarks

The Field parameter contains the name of the HTTP header (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).

Log Event (Atom Class)

Fires once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(AtomLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } AtomLogEventParams;
Unicode (Windows) virtual INT FireLog(AtomLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } AtomLogEventParams;
- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;
#define EID_ATOM_LOG 7

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

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.

The value 1 (Info) logs basic information including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

  • "Info"
  • "RequestHeaders"
  • "ResponseHeaders"
  • "RequestBody"
  • "ResponseBody"
  • "ProxyRequest"
  • "ProxyResponse"
  • "FirewallRequest"
  • "FirewallResponse"

Redirect Event (Atom Class)

Fired when a redirection is received from the server.

Syntax

ANSI (Cross Platform)
virtual int FireRedirect(AtomRedirectEventParams *e);
typedef struct {
const char *Location;
int Accept; int reserved; } AtomRedirectEventParams;
Unicode (Windows) virtual INT FireRedirect(AtomRedirectEventParams *e);
typedef struct {
LPCWSTR Location;
BOOL Accept; INT reserved; } AtomRedirectEventParams;
- (void)onRedirect:(NSString*)location :(int*)accept;
#define EID_ATOM_REDIRECT 8

virtual INT IPWORKS_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);

Remarks

This event is where the client can decide whether to continue with the redirection process or not. The Accept parameter is always true by default, but if you do not want to follow the redirection, Accept may be set to false, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (Atom Class)

Fired for every cookie set by the server.

Syntax

ANSI (Cross Platform)
virtual int FireSetCookie(AtomSetCookieEventParams *e);
typedef struct {
const char *Name;
const char *Value;
const char *Expires;
const char *Domain;
const char *Path;
int Secure; int reserved; } AtomSetCookieEventParams;
Unicode (Windows) virtual INT FireSetCookie(AtomSetCookieEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR Value;
LPCWSTR Expires;
LPCWSTR Domain;
LPCWSTR Path;
BOOL Secure; INT reserved; } AtomSetCookieEventParams;
- (void)onSetCookie:(NSString*)name :(NSString*)value :(NSString*)expires :(NSString*)domain :(NSString*)path :(BOOL)secure;
#define EID_ATOM_SETCOOKIE 9

virtual INT IPWORKS_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);

Remarks

The SetCookie event is fired for every "Set-Cookie:" header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

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

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted through a secure (HTTPS) connection only.

SSLServerAuthentication Event (Atom Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AtomSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } AtomSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(AtomSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } AtomSSLServerAuthenticationEventParams;
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
#define EID_ATOM_SSLSERVERAUTHENTICATION 10

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(AtomSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } AtomSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(AtomSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } AtomSSLStatusEventParams;
- (void)onSSLStatus:(NSString*)message;
#define EID_ATOM_SSLSTATUS 11

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (Atom Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartTransfer(AtomStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } AtomStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(AtomStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } AtomStartTransferEventParams;
- (void)onStartTransfer:(int)direction;
#define EID_ATOM_STARTTRANSFER 12

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

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

Status Event (Atom Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStatus(AtomStatusEventParams *e);
typedef struct {
const char *HTTPVersion;
int StatusCode;
const char *Description; int reserved; } AtomStatusEventParams;
Unicode (Windows) virtual INT FireStatus(AtomStatusEventParams *e);
typedef struct {
LPCWSTR HTTPVersion;
INT StatusCode;
LPCWSTR Description; INT reserved; } AtomStatusEventParams;
- (void)onStatus:(NSString*)HTTPVersion :(int)statusCode :(NSString*)description;
#define EID_ATOM_STATUS 13

virtual INT IPWORKS_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g. "1.1").

StatusCode contains the HTTP status code (e.g. 200), and Description the associated message returned by the server (e.g. "OK").

Transfer Event (Atom Class)

Fired while a document transfers (delivers document).

Syntax

ANSI (Cross Platform)
virtual int FireTransfer(AtomTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } AtomTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(AtomTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } AtomTransferEventParams;
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;
#define EID_ATOM_TRANSFER 14

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

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

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

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

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

Configuration Settings (Atom Class)

The class accepts one or more of the following configuration settings. Configuration 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.

HTTP Configuration Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is true, the class adds an "Accept-Encoding: " header to the request being sent to the server. By default, this header's value is "gzip, deflate". This config allows you to change the value of the "Accept-Encoding" header. NOTE: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It will then uncompress the data it has received. The class will handle data compressed by both GZIP and Deflate compression algorithms.

When true, the class adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server does not support HTTP/2. This setting is only applicable when HTTPVersion is set to "2.0".

If set to True (default) the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This setting determines whether data is appended when writing to LocalFile. When set to True downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is only applicable when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

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

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

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

BytesTransferred:   Contains the number of bytes transferred in the response data.

Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is only applicable when UseChunkedEncoding is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to true, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to true the URL will be encoded by the class.

If set to True the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

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

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same, otherwise the class fails with an error.

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

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

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

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

Valid options are:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to true the class will perform a GET on the new location.

The default value is false. If set to true the class will perform a GET on the new location. Otherwise it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically these headers are inserted into the table via incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are:

  • "1.0"
  • "1.1" (default)
  • "2.0"

When using HTTP/2 ("2.0") additional restrictions apply. Please see notes below for details.

HTTP/2 Notes

When using HTTP/2 only secure (TLS/SSL) connections are currently supported. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2 the class will automatically use HTTP/1.1 instead. This is done in order to provide compatibility without the need for any additional settings. To see which version was used check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on Windows 8.1/Server 2012 R2 or later. If HTTP/2 is used on a version of Windows prior to these versions the class fails with an error.

Note: HTTP/2 is currently only supported on Windows.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

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

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the 'Connection: Close' header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.

The value 1 (Info) logs basic information including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value besides frNever the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" if the server does not support "2.0" the class will fallback to using "1.1" automatically. This setting will indicate which was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration option can be set to a string of headers to be appended to the HTTP request headers.

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

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

This configuration option is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This setting is provided for use by classs that do not directly expose Proxy properties.

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

This setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

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

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this config to ON before making a request to enable it. Examples are below.

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to true, the class will use HTTP chunked encoding when posting if possible. HTTP chunked encoding allows large files to be sent in chunks instead of all at once. If set to false, the class will not use HTTP chunked encoding. The default value is false.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True if a hostname contains non-ASCII characters it is encoded using Punycode to an IDN.

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance to specify UTF-8 set CodePage to 65001. In the C++ Edition for Windows the *W version of the class must be used. For instance DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

If True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).

Note: This setting is only applicable to Mac/iOS editions.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

IPPort Configuration Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the number of times that the keep-alive packets will be re-sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform, and isn't supported in Mac OS or FreeBSD.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 setting 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).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This setting optionally specifies a semicolon separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Configuration Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if UseInternalSecurityAPI is False.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when UseInternalSecurityAPI is False (default) include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when UseInternalSecurityAPI is True: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when UseInternalSecurityAPI is True include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList setting.

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when UseInternalSecurityAPI is set to true.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when UseInternalSecurityAPI is set to True.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedProtocol:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedProtocol[connId]");

SSLProvider:   The name of the security provider to use.

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed .

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: IPPort.Config("UseInternalSecurityAPI=true"); IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2 IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13Provider:   The TLS 1.3 implementation to be used.

This setting specifies the TLS 1.3 implementation which will be used when TLS 1.3 is enabled via SSLEnabledProtocols. Possible values are:

  • 0 (Internal - Default)
  • 1 (Platform)

The platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (Atom 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.

ATOM Errors

304   Cannot write to file.
305   Cannot read from file.
501   Invalid property name.

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

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open AttachedFile.

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

IPPort Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   Cannot change UseConnection option while the class is Active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

XML Errors

101   Invalid attribute index.
102   No attributes available.
103   Invalid namespace index.
104   No namespaces available.
105   Invalid element index.
106   No elements available.
107   Attribute does not exist.
201   Unbalanced element tag.
202   Unknown element prefix (can't find namespace).
203   Unknown attribute prefix (can't find namespace).
204   Invalid XML markup.
205   Invalid end state for parser.
206   Document contains unbalanced elements.
207   Invalid XPath.
208   No such child.
209   Top element does not match start of path.
210   DOM tree unavailable (set BuildDOM to true and reparse).
302   Can't open file.
401   Invalid XML would be generated.
402   An invalid XML name has been specified.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 C++ Edition - Version 22.0 [Build 8171]