FILEHTMLLOADOPTIONS (original) (raw)
Summary
The FILEHTMLLOADOPTIONS structure provides information for loading HTML files.
Syntax
typedef struct _FILEHTMLLOADOPTIONS
{
[L_UINT](leadtools-basic-data-types.html) uStructSize;
[L_CHAR](leadtools-basic-data-types.html) szDomainWhitelist[FILEHTMLLOADOPTIONS_DOMAINWHITELISTSIZE];
[L_BOOL](leadtools-basic-data-types.html) bEnableJS;
[L_HTMLENGINE](l-htmlengine.html) HtmlEngine;
[L_UINT](leadtools-basic-data-types.html) uFlags;
} FILEHTMLLOADOPTIONS, *pFILEHTMLLOADOPTIONS;
Members
uStructSize
Size of this structure in bytes, for versioning. Use the sizeof() operator to calculate this value.
szDomainWhitelist
List of domains to allow when parsing links in the input HTML file. Any external links that are encountered will be ignored if the domains are not included in szDomainWhitelist.
bEnableJS
Flag indicating whether to enable or disable running JavaScript resources embedded in the HTML files during the rendering process. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Enable JavaScript effects. |
| FALSE | Disable JavaScript effects. |
HtmlEngine
The HTML engine to use when rendering HTML files.
uFlags
Reserved for future use. Pass 0.
Comments
Some functions which take this structure as a parameter require that the structure be initialized prior to the function call. You must set the uStructSize member to the total size, in bytes, of the structure. Use the sizeof() operator to calculate this value. Functions that do not require the structure to be initialized will take the total size of the structure, in bytes, as an additional function parameter.
szDomainWhitelist can contain several domains, separated using the | character. So setting the domain list to "domain1.com|domain2.com" will show images from domain1.com, www.domain1.com, domain2.com or www.domain2.com.
szDomainWhitelist can also use the wildcard '*', which can represent anything of zero or more characters. So *domain.com will accept images from domain.com, www.domain.com, images-domain.com, images.domain.com, etc. In other words using *domain.com will show images from any domain name that ends in "domain.com". The wildcard can also be in the middle of the string, so domain*.com will accept domain.com, domain1.com, domain2.com, domainxx.com, etc.