HtmlToXml Unicode C Reference Documentation

HtmlToXml

Current Version: 9.5.0.73

Class for converting HTML to well-formed XML for the purpose of programmatically extracting (scraping) information from any HTML page.

Create/Dispose

HCkHtmlToXmlW instance = CkHtmlToXmlW_Create();
// ...
CkHtmlToXmlW_Dispose(instance);
HCkHtmlToXmlW CkHtmlToXmlW_Create(void);

Creates an instance of the HCkHtmlToXmlW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkHtmlToXmlW_Dispose(HCkHtmlToXmlW handle);

Objects created by calling CkHtmlToXmlW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkHtmlToXmlW_Dispose.

Properties

DebugLogFilePath
void CkHtmlToXmlW_getDebugLogFilePath(HCkHtmlToXmlW cHandle, HCkString retval);
void CkHtmlToXmlW_putDebugLogFilePath(HCkHtmlToXmlW cHandle, const wchar_t *newVal);
const wchar_t *CkHtmlToXmlW_debugLogFilePath(HCkHtmlToXmlW cHandle);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DropCustomTags
BOOL CkHtmlToXmlW_getDropCustomTags(HCkHtmlToXmlW cHandle);
void CkHtmlToXmlW_putDropCustomTags(HCkHtmlToXmlW cHandle, BOOL newVal);

If set to true, then any non-standard HTML tags will be dropped when converting to XML.

top
Html
void CkHtmlToXmlW_getHtml(HCkHtmlToXmlW cHandle, HCkString retval);
void CkHtmlToXmlW_putHtml(HCkHtmlToXmlW cHandle, const wchar_t *newVal);
const wchar_t *CkHtmlToXmlW_html(HCkHtmlToXmlW cHandle);

The HTML to be converted by the ToXml method. To convert HTML to XML, first set this property to the HTML string and then call ToXml. The ConvertFile method can do file-to-file conversions.

top
LastErrorHtml
void CkHtmlToXmlW_getLastErrorHtml(HCkHtmlToXmlW cHandle, HCkString retval);
const wchar_t *CkHtmlToXmlW_lastErrorHtml(HCkHtmlToXmlW cHandle);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void CkHtmlToXmlW_getLastErrorText(HCkHtmlToXmlW cHandle, HCkString retval);
const wchar_t *CkHtmlToXmlW_lastErrorText(HCkHtmlToXmlW cHandle);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void CkHtmlToXmlW_getLastErrorXml(HCkHtmlToXmlW cHandle, HCkString retval);
const wchar_t *CkHtmlToXmlW_lastErrorXml(HCkHtmlToXmlW cHandle);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
BOOL CkHtmlToXmlW_getLastMethodSuccess(HCkHtmlToXmlW cHandle);
void CkHtmlToXmlW_putLastMethodSuccess(HCkHtmlToXmlW cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Nbsp
int CkHtmlToXmlW_getNbsp(HCkHtmlToXmlW cHandle);
void CkHtmlToXmlW_putNbsp(HCkHtmlToXmlW cHandle, int newVal);

Determines how to handle   HTML entities. The default value, 0 will cause   entites to be convert to normal space characters (ASCII value 32). If this property is set to 1, then  's will be converted to &#160. If set to 2, then &nbps;'s are dropped. If set to 3, then &nbsp's are left unmodified.

top
VerboseLogging
BOOL CkHtmlToXmlW_getVerboseLogging(HCkHtmlToXmlW cHandle);
void CkHtmlToXmlW_putVerboseLogging(HCkHtmlToXmlW cHandle, BOOL newVal);

If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void CkHtmlToXmlW_getVersion(HCkHtmlToXmlW cHandle, HCkString retval);
const wchar_t *CkHtmlToXmlW_version(HCkHtmlToXmlW cHandle);

Version of the component/library, such as "9.5.0.63"

top
XmlCharset
void CkHtmlToXmlW_getXmlCharset(HCkHtmlToXmlW cHandle, HCkString retval);
void CkHtmlToXmlW_putXmlCharset(HCkHtmlToXmlW cHandle, const wchar_t *newVal);
const wchar_t *CkHtmlToXmlW_xmlCharset(HCkHtmlToXmlW cHandle);

The charset, such as "utf-8" or "iso-8859-1" of the XML to be created. If XmlCharset is empty, the XML is created in the same character encoding as the HTML. Otherwise the HTML is converted XML and converted to this charset.

top

Methods

ConvertFile
BOOL CkHtmlToXmlW_ConvertFile(HCkHtmlToXmlW cHandle, const wchar_t *inHtmlPath, const wchar_t *destXmlPath);

Converts an HTML file to a well-formed XML file that can be parsed for the purpose of programmatically extracting information.

Returns TRUE for success, FALSE for failure.

top
DropTagType
void CkHtmlToXmlW_DropTagType(HCkHtmlToXmlW cHandle, const wchar_t *tagName);

Allows for any specified tag to be dropped from the output XML. To drop more than one tag, call this method once for each tag type to be dropped.

top
DropTextFormattingTags
void CkHtmlToXmlW_DropTextFormattingTags(HCkHtmlToXmlW cHandle);

Causes text formatting tags to be dropped from the XML output. Text formatting tags are: b, font, i, u, br, center, em, strong, big, tt, s, small, strike, sub, and sup.

top
IsUnlocked
BOOL CkHtmlToXmlW_IsUnlocked(HCkHtmlToXmlW cHandle);

Returns TRUE if the component is already unlocked. Otherwise returns FALSE.

top
ReadFile
BOOL CkHtmlToXmlW_ReadFile(HCkHtmlToXmlW cHandle, const wchar_t *path, const unsigned char * outBytes);

Convenience method for reading a complete file into a byte array.

Returns TRUE for success, FALSE for failure.

top
ReadFileToString
BOOL CkHtmlToXmlW_ReadFileToString(HCkHtmlToXmlW cHandle, const wchar_t *filename, const wchar_t *srcCharset, const wchar_t *outStr);
const wchar_t *CkHtmlToXmlW_readFileToString(HCkHtmlToXmlW cHandle, const wchar_t *filename, const wchar_t *srcCharset);

Convenience method for reading a text file into a string. The character encoding of the text file is specified by srcCharset. Valid values, such as "iso-8895-1" or "utf-8" are listed at: List of Charsets.

Returns TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkHtmlToXmlW_SaveLastError(HCkHtmlToXmlW cHandle, const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top
SetHtmlBytes
void CkHtmlToXmlW_SetHtmlBytes(HCkHtmlToXmlW cHandle, const unsigned char * inData);

Sets the Html property from a byte array.

top
SetHtmlFromFile
BOOL CkHtmlToXmlW_SetHtmlFromFile(HCkHtmlToXmlW cHandle, const wchar_t *filename);

Sets the Html property by loading the HTML from a file.

Returns TRUE for success, FALSE for failure.

top
ToXml
BOOL CkHtmlToXmlW_ToXml(HCkHtmlToXmlW cHandle, const wchar_t *outStr);
const wchar_t *CkHtmlToXmlW_toXml(HCkHtmlToXmlW cHandle);

Converts the HTML in the "Html" property to XML and returns the XML string.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
UndropTagType
void CkHtmlToXmlW_UndropTagType(HCkHtmlToXmlW cHandle, const wchar_t *tagName);

Causes a specified type of tag to NOT be dropped in the output XML.

top
UndropTextFormattingTags
void CkHtmlToXmlW_UndropTextFormattingTags(HCkHtmlToXmlW cHandle);

Causes text formatting tags to NOT be dropped from the XML output. Text formatting tags are: b, font, i, u, br, center, em, strong, big, tt, s, small, strike, sub, and sup.

Important: Text formatting tags are dropped by default. Call this method to prevent text formatting tags from being dropped.

top
UnlockComponent
BOOL CkHtmlToXmlW_UnlockComponent(HCkHtmlToXmlW cHandle, const wchar_t *unlockCode);

Unlocks the component. An arbitrary unlock code may be passed to automatically begin a 30-day trial.

Returns TRUE for success, FALSE for failure.

top
WriteFile
BOOL CkHtmlToXmlW_WriteFile(HCkHtmlToXmlW cHandle, const wchar_t *path, const unsigned char * fileData);

Convenience method for saving a byte array to a file.

Returns TRUE for success, FALSE for failure.

top
WriteStringToFile
BOOL CkHtmlToXmlW_WriteStringToFile(HCkHtmlToXmlW cHandle, const wchar_t *stringToWrite, const wchar_t *filename, const wchar_t *charset);

Convenience method for saving a string to a file. The character encoding of the output text file is specified by charset (the string is converted to this charset when writing). Valid values, such as "iso-8895-1" or "utf-8" are listed at: List of Charsets.

Returns TRUE for success, FALSE for failure.

top
Xml
BOOL CkHtmlToXmlW_Xml(HCkHtmlToXmlW cHandle, const wchar_t *outStr);
const wchar_t *CkHtmlToXmlW_xml(HCkHtmlToXmlW cHandle);

This is the same as the "ToXml" method. It converts the HTML in the "Html" property to XML and returns the XML string.

Returns TRUE for success, FALSE for failure.

top