IIXC_Image::Load Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 7: | Line 7: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Load([in] LPWSTR | + | <pre class="brush:cpp;gutter:false">HRESULT Load([in] LPWSTR sImagePath, |
| − | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG nFlags);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sImagePath |
:[in] Value of LPWSTR is the null-terminated file name string. | :[in] Value of LPWSTR is the null-terminated file name string. | ||
| − | ; | + | ;nFlags |
:[in, defaultvalue(0)] The following [[PXV:IXC_ImageLoadFlags|flag]] can be used to specify how the image will be loaded. | :[in, defaultvalue(0)] The following [[PXV:IXC_ImageLoadFlags|flag]] can be used to specify how the image will be loaded. | ||
Latest revision as of 02:15, 15 June 2015
This method loads an image from the selected file.
Syntax
HRESULT Load([in] LPWSTR sImagePath,
[in, defaultvalue(0)] ULONG nFlags);
Parameters
- sImagePath
- [in] Value of LPWSTR is the null-terminated file name string.
- nFlags
- [in, defaultvalue(0)] The following flag can be used to specify how the image will be loaded.
Return Value
Returns S_OK if the operation was successful, and will return an error code if it fails.
Remarks
By default Load opens the image file, acquires information about all pages, decodes all of them, and closes the file. This is a good approach for single page files, but when dealing with large multi-paged files, this may cause unnecessary memory usage and performance degradation. To avoid this situation, Load should be called with the ImageLoad_Deferred flag. In this case, the image file will be analyzed, information about its pages will be acquired, but actual page data will not be decoded immediately.
