CkMhtW Unicode C++ Reference Documentation

CkMhtW

Current Version: 10.1.0

Requires Chilkat Bundle License

Chilkat MHT can generate email objects from HTML files and URLs, and convert HTML to MHT or EML files.

Object Creation

// Local variable on the stack
CkMhtW obj;

// Dynamically allocate/delete
CkMhtW *pObj = new CkMhtW();
// ...
delete pObj;

Properties

AbortCurrent

bool get_AbortCurrent(void);
void put_AbortCurrent(bool newVal);

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

BaseUrl

void get_BaseUrl(CkString &str);
const wchar_t *baseUrl(void);
void put_BaseUrl(const wchar_t *str);

When processing an HTML file or string (not a website URL), this defines the base URL to be used when converting relative HREFs to absolute HREFs.

ConnectTimeout

int get_ConnectTimeout(void);
void put_ConnectTimeout(int newVal);

The amount of time in seconds to wait before timing out when connecting to an HTTP server. The default value is 10 seconds.

DebugHtmlAfter

void get_DebugHtmlAfter(CkString &str);
const wchar_t *debugHtmlAfter(void);
void put_DebugHtmlAfter(const wchar_t *str);

A filename to save the result HTML when converting a URL, file, or HTML string. If problems are experienced, the before/after HTML can be analyzed to help determine the cause.

DebugHtmlBefore

void get_DebugHtmlBefore(CkString &str);
const wchar_t *debugHtmlBefore(void);
void put_DebugHtmlBefore(const wchar_t *str);

A filename to save the input HTML when converting a URL, file, or HTML string. If problems are experienced, the before/after HTML can be analyzed to help determine the cause.

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

DebugTagCleaning

bool get_DebugTagCleaning(void);
void put_DebugTagCleaning(bool newVal);

When true causes the Mht class to be much more verbose in its logging. The default is false.

EmbedImages

bool get_EmbedImages(void);
void put_EmbedImages(bool newVal);

Controls whether images are embedded in the MHT/EML, or whether the IMG SRC attributes are left as external URL references. If false, the IMG SRC tags are converted to absolute URLs (if necessary) and the images are not embedded within the MHT/EML.

EmbedLocalOnly

bool get_EmbedLocalOnly(void);
void put_EmbedLocalOnly(bool newVal);

If true, only images found on the local filesystem (i.e. links to files) will be embedded within the MHT.

FetchFromCache

bool get_FetchFromCache(void);
void put_FetchFromCache(bool newVal);

If true, page parts such as images, style sheets, etc. will be fetched from the disk cache if possible. The disk cache root may be defined by calling AddCacheRoot. The default value is false.

HeartbeatMs

int get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

The time interval, in milliseconds, between AbortCheck event callbacks. The heartbeat/AbortCheck provides a means for an application to abort any MHT method before completion.

The default value is 0, which means that no AbortCheck events will be fired.

IgnoreMustRevalidate

bool get_IgnoreMustRevalidate(void);
void put_IgnoreMustRevalidate(bool newVal);

Some HTTP responses contain a "Cache-Control: must-revalidate" header. If this is present, the server is requesting that the client always issue a revalidate HTTP request instead of serving the page directly from cache. If IgnoreMustRevalidate is set to true, then Chilkat MHT will serve the page directly from cache without revalidating until the page is no longer fresh. (assuming that FetchFromCache is set to true)

The default value of this property is false.

IgnoreNoCache

bool get_IgnoreNoCache(void);
void put_IgnoreNoCache(bool newVal);

Some HTTP responses contain headers of various types that indicate that the page should not be cached. Chilkat MHT will adhere to this unless this property is set to true.

The default value of this property is false.

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

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.

LastErrorText

void get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

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.

LastMethodSuccess

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

NoScripts

bool get_NoScripts(void);
void put_NoScripts(bool newVal);

Only applies when creating MHT files. Scripts are always removed when creating EML or emails from HTML. If set to true, then all scripts are removed, if set to false (the default) then scripts are not removed.

NtlmAuth

bool get_NtlmAuth(void);
void put_NtlmAuth(bool newVal);

Setting this property to true causes the MHT component to use NTLM authentication (also known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server.

The default value of this property is false.

NumCacheLevels

int get_NumCacheLevels(void);
void put_NumCacheLevels(int newVal);

The number of directory levels to be used under each cache root. The default is 0, meaning that each cached item is stored in a cache root directory. A value of 1 causes each cached page to be stored in one of 255 subdirectories named "0","1", "2", ..."255" under a cache root. A value of 2 causes two levels of subdirectories ("0..255/0..255") under each cache root. The MHT control automatically creates subdirectories as needed. The reason for mutliple levels is to alleviate problems that may arise when huge numbers of files are stored in a single directory. For example, Windows Explorer does not behave well when trying to display the contents of directories with thousands of files.

NumCacheRoots

int get_NumCacheRoots(void);

The number of cache roots to be used for the disk cache. This allows the disk cache spread out over multiple disk drives. Each cache root is a string indicating the drive letter and directory path. For example, "E:\Cache". To create a cache with four roots, call AddCacheRoot once for each directory root.

PreferIpv6

bool get_PreferIpv6(void);
void put_PreferIpv6(bool newVal);

If true, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is false, which will choose IPv4 over IPv6.

PreferMHTScripts

bool get_PreferMHTScripts(void);
void put_PreferMHTScripts(bool newVal);

This property provides a means for the noscript option to be selected when possible. If PreferMHTScripts = false, then scripts with noscript alternatives are removed and the noscript content is kept. If true (the default), then scripts are preserved and the noscript options are discarded.

Proxy

void get_Proxy(CkString &str);
const wchar_t *proxy(void);
void put_Proxy(const wchar_t *str);

(Optional) A proxy host:port if a proxy is necessary to access the Internet. The proxy string should be formatted as "hostname:port", such as "www.chilkatsoft.com:100".

ProxyLogin

void get_ProxyLogin(CkString &str);
const wchar_t *proxyLogin(void);
void put_ProxyLogin(const wchar_t *str);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

ProxyPassword

void get_ProxyPassword(CkString &str);
const wchar_t *proxyPassword(void);
void put_ProxyPassword(const wchar_t *str);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

ReadTimeout

int get_ReadTimeout(void);
void put_ReadTimeout(int newVal);

The amount of time in seconds to wait before timing out when reading from an HTTP server. The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long data transfer, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire data transfer.

The default value is 20 seconds.

RequireSslCertVerify

bool get_RequireSslCertVerify(void);
void put_RequireSslCertVerify(bool newVal);

If true, then the HTTP client will verify the server's SSL certificate. The certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is false.

SocksHostname

void get_SocksHostname(CkString &str);
const wchar_t *socksHostname(void);
void put_SocksHostname(const wchar_t *str);

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

SocksPassword

void get_SocksPassword(CkString &str);
const wchar_t *socksPassword(void);
void put_SocksPassword(const wchar_t *str);

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

SocksPort

int get_SocksPort(void);
void put_SocksPort(int newVal);

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

SocksUsername

void get_SocksUsername(CkString &str);
const wchar_t *socksUsername(void);
void put_SocksUsername(const wchar_t *str);

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

SocksVersion

int get_SocksVersion(void);
void put_SocksVersion(int newVal);

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

UnpackDirect

bool get_UnpackDirect(void);
void put_UnpackDirect(bool newVal);

Introduced in version 9.5.0.47

If true, then the UnpackMHT and UnpackMHTString methods will unpack the MHT directly with no transformations. Normally, the related parts are unpacked to a "parts" sub-directory, and the unpacked HTML is edited to update references to point to the unpacked image and script files. When unpacking direct, the HTML is not edited, and the related parts are unpacked to sub-directories rooted in the directory where HTML file is created (i.e. the unpack directory). When unpacking direct, the "partsSubDir" argument of the UnpackMHT* methods is unused.

Note: It is only possible to directly unpack MHT files where the Content-Location headers DO NOT contain URLs. The MHT must be such that the Content-Location headers of the related items contain relative paths.

Note: The default value of this property is false.

UnpackUseRelPaths

bool get_UnpackUseRelPaths(void);
void put_UnpackUseRelPaths(bool newVal);

Controls whether absolute or relative paths are used when referencing images in the unpacked HTML. The default value is true indicating that relative paths will be used. To use absolute paths, set this property value equal to false.

UpdateCache

bool get_UpdateCache(void);
void put_UpdateCache(bool newVal);

Controls whether the cache is automatically updated with the responses from HTTP GET requests. If true, the disk cache is updated, if false (the default), the cache is not updated.

UseCids

bool get_UseCids(void);
void put_UseCids(bool newVal);

Controls whether CID URLs are used for embedded references when generating MHT or EML documents. If UseCids is false, then URLs are left unchanged and the embedded items will contain "content-location" headers that match the URLs in the HTML. If true, CIDs are generated and the URLs within the HTML are replaced with "CID:" links.

The default value of this property is true.

UseFilename

bool get_UseFilename(void);
void put_UseFilename(bool newVal);

If true, a "filename" attribute is added to each Content-Disposition MIME header field for each embedded item (image, style sheet, etc.). If false, then no filename attribute is added.

The default value of this property is true.

UseIEProxy

bool get_UseIEProxy(void);
void put_UseIEProxy(bool newVal);

If true, the proxy host/port used by Internet Explorer will also be used by Chilkat MHT.

UseInline

bool get_UseInline(void);
void put_UseInline(bool newVal);

If true, an "inline" attribute is added to each Content-Disposition MIME header field for each embedded item (image, style sheet, etc.). If false, then no inline attribute is added.

The default value of this property is true.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(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.

Version

void get_Version(CkString &str);
const wchar_t *version(void);

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

More Information and Examples

How to get the Chilkat version at runtime.

WebSiteLogin

void get_WebSiteLogin(CkString &str);
const wchar_t *webSiteLogin(void);
void put_WebSiteLogin(const wchar_t *str);

(Optional) Specifies the login if a a Web page is accessed that requires a login

WebSiteLoginDomain

void get_WebSiteLoginDomain(CkString &str);
const wchar_t *webSiteLoginDomain(void);
void put_WebSiteLoginDomain(const wchar_t *str);

The optional domain name to be used with NTLM authentication.

WebSitePassword

void get_WebSitePassword(CkString &str);
const wchar_t *webSitePassword(void);
void put_WebSitePassword(const wchar_t *str);

Optional) Specifies the password if a a Web page is accessed that requires a login and password

Methods

AddCacheRoot

void AddCacheRoot(const wchar_t *dir);

If disk caching is used, this must be called once for each cache root. For example, if the cache is spread across D:\cacheRoot, E:\cacheRoot, and F:\cacheRoot, an application would setup the cache object by calling AddRoot three times -- once with "D:\cacheRoot", once with "E:\cacheRoot", and once with "F:\cacheRoot".

More Information and Examples

Download Web Page to MHT with w/ Disk Cache

AddCustomHeader

void AddCustomHeader(const wchar_t *name, const wchar_t *value);

Adds a custom HTTP header to all HTTP requests sent by the MHT component. To add multiple header fields, call this method once for each custom header.

AddExternalStyleSheet

void AddExternalStyleSheet(const wchar_t *url);

(This method rarely needs to be called.) Includes an additional style sheet that would not normally be included with the HTML. This method is provided for cases when style sheet names are constructed and dynamically included in Javascript such that MHT .NET cannot know beforehand what stylesheet to embed. MHT .NET by default downloads and embeds all stylesheets externally referenced by the HTML

ClearCustomHeaders

void ClearCustomHeaders(void);

Removes all custom headers that may have accumulated from previous calls to AddCustomHeader.

ExcludeImagesMatching

void ExcludeImagesMatching(const wchar_t *pattern);

(This method rarely needs to be called.) Tells Chilkat MHT .NET to not embed any images whose URL matches a pattern. Sometimes images can be referenced within style sheets and not actually used when rendering the page. In cases like those, the image will appear as an attachment in the HTML email. This feature allows you to explicitly remove those images from the email so no attachments appear.

GetAndSaveEML

bool GetAndSaveEML(const wchar_t *url_or_htmlFilepath, const wchar_t *emlPath);

Creates an EML file from a web page or HTML file. All external images and style sheets are downloaded and embedded in the EML file.

Returns true for success, false for failure.

GetAndSaveEMLAsync ⁽¹⁾

CkTaskW *GetAndSaveEMLAsync(const wchar_t *url_or_htmlFilepath, const wchar_t *emlPath);

Creates an asynchronous task to call the GetAndSaveEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

GetAndSaveMHT

bool GetAndSaveMHT(const wchar_t *url_or_htmlFilepath, const wchar_t *mhtPath);

Creates an MHT file from a web page or local HTML file. All external images, scripts, and style sheets are downloaded and embedded in the MHT file.

Returns true for success, false for failure.

More Information and Examples

Example to Download Web Page as MHT Archive Pack Local HTML File and Referenced Images as MHT Archive

GetAndSaveMHTAsync ⁽¹⁾

CkTaskW *GetAndSaveMHTAsync(const wchar_t *url_or_htmlFilepath, const wchar_t *mhtPath);

Creates an asynchronous task to call the GetAndSaveMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

GetAndZipEML

bool GetAndZipEML(const wchar_t *url_or_htmlFilepath, const wchar_t *zipEntryFilename, const wchar_t *zipFilename);

Creates an EML file from a web page or HTML file, compresses, and appends to a new or existing Zip file. All external images and style sheets are downloaded and embedded in the EML.

Returns true for success, false for failure.

GetAndZipEMLAsync ⁽¹⁾

CkTaskW *GetAndZipEMLAsync(const wchar_t *url_or_htmlFilepath, const wchar_t *zipEntryFilename, const wchar_t *zipFilename);

Creates an asynchronous task to call the GetAndZipEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

GetAndZipMHT

bool GetAndZipMHT(const wchar_t *url_or_htmlFilepath, const wchar_t *zipEntryFilename, const wchar_t *zipFilename);

Creates an MHT file from a web page or HTML file, compresses, and appends to a new or existing Zip file. All external images and style sheets are downloaded and embedded in the MHT.

Returns true for success, false for failure.

GetAndZipMHTAsync ⁽¹⁾

CkTaskW *GetAndZipMHTAsync(const wchar_t *url_or_htmlFilepath, const wchar_t *zipEntryFilename, const wchar_t *zipFilename);

Creates an asynchronous task to call the GetAndZipMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

GetCacheRoot

bool GetCacheRoot(int index, CkString &outStr);
const wchar_t *getCacheRoot(int index);

Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times.

Returns true for success, false for failure.

GetEML

bool GetEML(const wchar_t *url_or_htmlFilepath, CkString &outStr);
const wchar_t *getEML(const wchar_t *url_or_htmlFilepath);

Creates EML from a web page or HTML file, and returns the EML (MIME) message data as a string.

Returns true for success, false for failure.

GetEMLAsync ⁽¹⁾

CkTaskW *GetEMLAsync(const wchar_t *url_or_htmlFilepath);

Creates an asynchronous task to call the GetEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

GetMHT

bool GetMHT(const wchar_t *url_or_htmlFilepath, CkString &outStr);
const wchar_t *getMHT(const wchar_t *url_or_htmlFilepath);

Creates MHT from a web page or local HTML file, and returns the MHT (MIME) message data as a string

Returns true for success, false for failure.

GetMHTAsync ⁽¹⁾

CkTaskW *GetMHTAsync(const wchar_t *url_or_htmlFilepath);

Creates an asynchronous task to call the GetMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

HtmlToEML

bool HtmlToEML(const wchar_t *htmlText, CkString &outStr);
const wchar_t *htmlToEML(const wchar_t *htmlText);

Creates an in-memory EML string from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the EML string that is returned.

Returns true for success, false for failure.

HtmlToEMLAsync ⁽¹⁾

CkTaskW *HtmlToEMLAsync(const wchar_t *htmlText);

Creates an asynchronous task to call the HtmlToEML method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

HtmlToEMLFile

bool HtmlToEMLFile(const wchar_t *html, const wchar_t *emlFilename);

Creates an EML file from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the EML file.

Returns true for success, false for failure.

HtmlToEMLFileAsync ⁽¹⁾

CkTaskW *HtmlToEMLFileAsync(const wchar_t *html, const wchar_t *emlFilename);

Creates an asynchronous task to call the HtmlToEMLFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

HtmlToMHT

bool HtmlToMHT(const wchar_t *htmlText, CkString &outStr);
const wchar_t *htmlToMHT(const wchar_t *htmlText);

Creates an in-memory MHT web archive from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the MHT string.

Returns true for success, false for failure.

HtmlToMHTAsync ⁽¹⁾

CkTaskW *HtmlToMHTAsync(const wchar_t *htmlText);

Creates an asynchronous task to call the HtmlToMHT method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

HtmlToMHTFile

bool HtmlToMHTFile(const wchar_t *html, const wchar_t *mhtFilename);

Creates an MHT file from an in-memory HTML string. All external images and style sheets are downloaded and embedded in the MHT file.

Returns true for success, false for failure.

HtmlToMHTFileAsync ⁽¹⁾

CkTaskW *HtmlToMHTFileAsync(const wchar_t *html, const wchar_t *mhtFilename);

Creates an asynchronous task to call the HtmlToMHTFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

LoadTaskCaller

bool LoadTaskCaller(CkTaskW &task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

RemoveCustomHeader

void RemoveCustomHeader(const wchar_t *name);

Removes a custom header by header field name.

RestoreDefaults

void RestoreDefaults(void);

Restores the default property settings.

UnpackMHT

bool UnpackMHT(const wchar_t *mhtFilename, const wchar_t *unpackDir, const wchar_t *htmlFilename, const wchar_t *partsSubDir);

Unpacks the contents of a MHT file. The destination directory is specified by unpackDir. The name of the HTML file created is specified by htmlFilename, and supporting files (images, javascripts, etc.) are created in partsSubDir, which is automatically created if it does not already exist.

Returns true for success, false for failure.

More Information and Examples

Unpack MHT to Files

UnpackMHTString

bool UnpackMHTString(const wchar_t *mhtString, const wchar_t *unpackDir, const wchar_t *htmlFilename, const wchar_t *partsSubDir);

Same as UnpackMHT, except the MHT is passed in as an in-memory string.

Returns true for success, false for failure.

More Information and Examples

Extract all HTML Objects from a Web Page

Events

To implement an event callback, your application would define and implement a class that inherits from CkBaseProgressW. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgressW base class.

For example:

  CkMhtW mht;

  MyMhtProgressW callbackObj;

  mht.put_EventCallbackObject(&callbackObj);

MyMhtProgressW example:

#include "CkBaseProgressW.h"

class MyMhtProgressW : public CkBaseProgressW {

  public:
    MyMhtProgressW();
    virtual ~MyMhtProgressW();

    void AbortCheck(bool  *abort);

    void PercentDone(int pctDone, bool  *abort);

    void ProgressInfo(const wchar_t *name, const wchar_t *value);

    void TaskCompleted(CkTaskW &task);

};

AbortCheck

void AbortCheck(bool *abort);

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

PercentDone

void PercentDone(int pctDone, bool *abort);

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

ProgressInfo

void ProgressInfo(const wchar_t *name, const wchar_t *value);

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

TaskCompleted

void TaskCompleted(CkTaskW &task);

Called in the background thread when an asynchronous task completes.

top