Mht

Set to 1 to request cancellation of the operation currently running on this object. Long-running network and file operations periodically check this property; a fast operation may complete before the request is observed.

A synchronous method can be cancelled from another thread by setting this property on the same object. Chilkat resets the property to 0 after an abort is processed, and a stale request is cleared when a later method begins.

Specifies the base URL used when the source is a local HTML file or an in-memory HTML string. Relative links and resource references are resolved against this value before MHT or EML output is created.

Specifies the maximum number of seconds allowed for establishing a connection to an HTTP server. The default is 10 seconds.

Specifies a local file path where Chilkat saves the HTML after it has been processed for MHT or EML generation. Leave the property empty to disable this diagnostic output.

Specifies a local file path where Chilkat saves the source HTML before it is transformed for MHT or EML generation. Leave the property empty to disable this diagnostic output.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Controls whether images referenced by the HTML are downloaded or read from disk and embedded as related MIME parts. When 0, image references remain external; relative image URLs are converted to absolute URLs when sufficient base information is available.

When 1, only images referenced from the local filesystem are embedded. Images referenced by HTTP or HTTPS URLs remain external. This setting is meaningful when EmbedImages is 1.

When 1, Chilkat attempts to satisfy page and resource requests from the configured disk cache before downloading them. Add one or more cache directories with AddCacheRoot. The default is 0.

Specifies the interval, in milliseconds, between AbortCheck event callbacks during supported long-running operations. The default is 0, which disables these periodic callbacks.

Controls how cached responses containing Cache-Control: must-revalidate are handled. When 0 (the default), Chilkat revalidates such a cached response before reuse. When 1, a still-fresh cached response may be used without revalidation. This property is relevant only when FetchFromCache is 1.

Controls whether HTTP response directives that prohibit or restrict caching are ignored. The default is 0, which honors the server's caching instructions. When 1, Chilkat may store responses that would otherwise be excluded from the disk cache.

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

The length, in characters, of the string contained in the LastStringResult property.

Controls script removal when creating MHT output. When 1, script content is removed. When 0 (the default), scripts may be preserved in MHT output according to the other script-related settings.

When 1, Chilkat uses NTLM authentication when the origin HTTP server requests authentication. The default is 0. Set WebSiteLogin, WebSitePassword, and, when required, WebSiteLoginDomain.

Specifies the number of directory levels used beneath each disk-cache root. The default is 0, which stores cached items directly in the root. A value of 1 distributes items among 256 subdirectories named 0 through 255. A value of 2 uses two such levels, for example 17/204. Chilkat creates the required subdirectories automatically.

Returns the number of disk-cache root directories currently configured through AddCacheRoot. Multiple roots allow cached items to be distributed across different directories or storage volumes.

Controls address-family preference when a hostname resolves to both IPv4 and IPv6 addresses. The default is 0, which prefers IPv4. Set to 1 to prefer IPv6.

Controls which content is retained when HTML contains a script together with a <noscript> alternative. When 1 (the default), the script is preferred and the <noscript> content is discarded. When 0, the script is removed and the <noscript> content is retained.

Specifies an HTTP proxy as hostname:port, for example proxy.example.com:8080. Leave the property empty when no explicit HTTP proxy is required.

Specifies the username used to authenticate with the HTTP proxy configured by Proxy. Leave empty when the proxy does not require authentication.

Specifies the password used to authenticate with the HTTP proxy configured by Proxy. Leave empty when the proxy does not require authentication.

Specifies the maximum number of seconds that an HTTP read may remain inactive while waiting for additional data. The default is 20 seconds. If data continues to arrive, a long download may run longer than this value.

Controls verification of the TLS server certificate for HTTPS connections. When 1, the connection is rejected if certificate verification fails, such as because the certificate is expired or its chain or signature cannot be validated. The default is 0.

Specifies the hostname or dotted-decimal IPv4 address of the SOCKS proxy. This property is used only when SocksVersion is 4 or 5.

Specifies the password for SOCKS5 proxy authentication. SOCKS4 does not define password authentication, so this property is ignored when SocksVersion is 4.

Specifies the TCP port of the SOCKS4 or SOCKS5 proxy. The default is 1080. This property is used only when SocksVersion is 4 or 5.

Specifies the username sent to the SOCKS4 or SOCKS5 proxy. It is used only when SocksVersion is 4 or 5. For SOCKS5, set SocksPassword when password authentication is required.

Selects whether requests are routed through a SOCKS proxy.

Controls whether an MHT archive is extracted without rewriting the HTML or relocating related resources into the normal parts subdirectory. The default is 0.

Controls how extracted resources are referenced from the rewritten HTML produced by the normal unpacking mode. The default is 1, which uses relative paths. Set to 0 to write absolute local paths.

Controls whether successful HTTP GET responses are written to the configured disk cache. The default is 0. When 1, add at least one cache root with AddCacheRoot.

Controls how embedded resources are referenced in generated MHT and EML MIME documents. The default is 1.

Controls whether Chilkat adds a filename parameter to the Content-Disposition header of each embedded resource, such as an image or style sheet. The default is 1.

When 1, Chilkat uses the proxy configuration associated with Windows Internet Options / Internet Explorer. This setting is relevant on Windows systems.

Controls whether embedded resources receive a Content-Disposition: inline header. The default is 1. When 0, Chilkat does not add the inline disposition for those resources.

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

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

Specifies the username used when the origin website requires HTTP authentication. It is optional for public pages. For NTLM authentication, also set NtlmAuth to 1 and provide a domain when required.

Specifies the optional Windows domain used with NTLM website authentication. This property is relevant when NtlmAuth is 1.

Specifies the password used with WebSiteLogin when the origin website requires HTTP authentication.

Adds dir as a root directory for the disk cache. Call this method once for each cache location the application wants Chilkat to use. Multiple roots may be placed on different directories or storage volumes.

Adds an HTTP request header to the requests sent while retrieving web pages and related resources. name is the header field name and value is its value. Call the method once for each custom header to add.

Adds the style sheet at url to the set of external CSS resources downloaded and embedded during conversion. This is normally unnecessary because Chilkat automatically discovers style sheets referenced directly by the HTML.

Removes all HTTP request headers previously added with AddCustomHeader. Built-in and automatically generated HTTP headers are not described as custom headers and are not the purpose of this method.

Adds pattern as an exclusion pattern for image URLs. Images whose URLs match an exclusion pattern are not embedded in the generated MHT or EML output.

Creates an EML email message from the web-page URL or local HTML file specified by url_or_htmlFilepath and saves it to emlPath. Referenced images and style sheets are fetched and embedded as related MIME parts.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the GetAndSaveEML method with the arguments provided.

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

Returns Nothing on failure

Creates an MHT web archive from the web-page URL or local HTML file specified by url_or_htmlFilepath and saves it to mhtPath. Referenced resources are fetched and embedded according to the current MHT properties.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the GetAndSaveMHT method with the arguments provided.

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

Returns Nothing on failure

Creates EML output from the web-page URL or local HTML file in url_or_htmlFilepath and stores it as zipEntryFilename inside the ZIP archive named by zipFilename. The ZIP file is created when it does not exist; otherwise the new entry is appended to the existing archive.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the GetAndZipEML method with the arguments provided.

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

Returns Nothing on failure

Creates MHT output from the web-page URL or local HTML file in url_or_htmlFilepath and stores it as zipEntryFilename inside the ZIP archive named by zipFilename. The ZIP file is created when it does not exist; otherwise the new entry is appended to the existing archive.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the GetAndZipMHT method with the arguments provided.

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

Returns Nothing on failure

Returns the cache-root directory at zero-based index index. Cache roots are added with AddCacheRoot, and their count is available from NumCacheRoots.

Returns Nothing on failure

Creates an EML MIME message from the web-page URL or local HTML file specified by url_or_htmlFilepath and returns the complete EML text in memory. Referenced images and style sheets are embedded as related MIME parts.

Returns Nothing on failure

Creates an asynchronous task to call the GetEML method with the arguments provided.

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

Returns Nothing on failure

Creates an MHT web archive from the web-page URL or local HTML file specified by url_or_htmlFilepath and returns the complete MHT MIME text in memory. Referenced resources are embedded according to the current property settings.

Returns Nothing on failure

Creates an asynchronous task to call the GetMHT method with the arguments provided.

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

Returns Nothing on failure

Creates an EML MIME message from the in-memory HTML string in htmlText and returns the complete EML text. External images and style sheets referenced by the HTML are fetched and embedded.

Returns Nothing on failure

Creates an asynchronous task to call the HtmlToEML method with the arguments provided.

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

Returns Nothing on failure

Creates an EML email message from the in-memory HTML string in html and saves it to the file path in emlFilename. External images and style sheets are fetched and embedded as related MIME parts.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the HtmlToEMLFile method with the arguments provided.

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

Returns Nothing on failure

Creates an MHT web archive from the in-memory HTML string in htmlText and returns the complete MHT MIME text. Related resources are fetched and embedded according to the current property settings.

Returns Nothing on failure

Creates an asynchronous task to call the HtmlToMHT method with the arguments provided.

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

Returns Nothing on failure

Creates an MHT web archive from the in-memory HTML string in html and saves it to the file path in mhtFilename. Related resources are fetched and embedded according to the current property settings.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the HtmlToMHTFile method with the arguments provided.

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

Returns Nothing on failure

Loads the calling object associated with an asynchronous Task. This method exists to support Chilkat's generated asynchronous calling infrastructure.

Returns 1 for success, 0 for failure.

Removes the custom HTTP request header whose field name is given by name. The name should be supplied without a trailing colon.

Restores the Mht object's configurable property values to their defaults.

Extracts the MHT file in mhtFilename into the directory specified by unpackDir. The main HTML document is written using filename htmlFilename. In normal mode, related files are written beneath the partsSubDir subdirectory, which Chilkat creates when necessary, and the HTML is rewritten to reference those extracted files.

Returns 1 for success, 0 for failure.

Extracts the in-memory MHT text in mhtString. unpackDir specifies the destination directory, htmlFilename specifies the main HTML filename, and partsSubDir specifies the related-parts subdirectory used by normal unpacking. Its extraction behavior is otherwise the same as UnpackMHT.

Returns 1 for success, 0 for failure.

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myMht As ChilkatMht

Private Sub myMht_AbortCheck(abort As Long)

	'Insert application code here.

End Sub

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to 1. This will cause the method to terminate and return a failure status or corresponding failure value.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myMht As ChilkatMht

Private Sub myMht_PercentDone(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myMht As ChilkatMht

Private Sub myMht_ProgressInfo(ByVal name As String, ByVal value As String)

	'Insert application code here.

End Sub

Called from the background thread when an asynchronous task completes.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Event Callbacks

Dim WithEvents myMht As ChilkatMht

Private Sub myMht_TaskCompleted(task As ChilkatTask)

	'Insert application code here.

End Sub