IPXV_ImportConverter::CheckFormat2 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_ImportConverter::CheckFormat2 Method}} | {{#customTitle:IPXV_ImportConverter::CheckFormat2 Method}} | ||
| − | {{#parentPage:PXV:IPXV_ImportConverter|CheckFormat2 | + | {{#parentPage:PXV:IPXV_ImportConverter#Methods|CheckFormat2|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Checks whether the source data is supported by the converter. If the data format is supported - the '''FmtCheckRes_OK''' result is being returned. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT CheckFormat2([in] IPXV_Inst* | + | <pre class="brush:cpp;gutter:false">HRESULT CheckFormat2([in] IPXV_Inst* pInst, |
| − | [in] IUnknown* | + | [in] IUnknown* pSrc, |
| − | [in] ULONG | + | [in] ULONG nFlags, |
| − | [out] ICab** | + | [out] ICab** pFmtDetails, |
| − | [out] IUnknown** | + | [out] IUnknown** pCheckRes, |
| − | [out, retval] | + | [out, retval] PXV_FmtCheckResult* pCheckResVal);</pre> |
== Parameters == | == Parameters == | ||
;pInst | ;pInst | ||
| − | :[in] Pointer to [[PXV:IPXV_Inst| | + | :[in] Pointer to [[PXV:IPXV_Inst| containing the instance of the program. |
;pSrc | ;pSrc | ||
| − | :[in] Pointer to IUnknown*. | + | :[in] Pointer to IUnknown* containing the source data. This should be cast to the data type that is supported by the converter. For example, the Image to PDF converter checks whether this pointer is an [[PXV:IIXC_Image|IIXC_Image]]. |
;nFlags | ;nFlags | ||
| − | :[in] Value of ULONG. | + | :[in] Value of ULONG containing the [[PXV:PXV_FmtCheckFlags|format check flags]]. |
| − | ; | + | ;pFmtDetails |
| − | :[out] Pointer to [[PXV:ICab|ICab]]. | + | :[out] Pointer to [[PXV:ICab|ICab]] containing the advanced format details cab node. Created by using the [[PXV:IPXV_FormatConverter_CreateParams|CreateParams]] method. |
| − | + | ||
| − | + | ||
;pCheckRes | ;pCheckRes | ||
| − | :[out, retval] Pointer to [[PXV: | + | :[out] Pointer to IUnknown* containing the additional result data. |
| + | ;pCheckResVal | ||
| + | :[out, retval] Pointer to [[PXV:PXV_FmtCheckResult|PXV_FmtCheckResult]] containing the format check result. | ||
== Return Value == | == Return Value == | ||
| Line 34: | Line 33: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXV_ImportConverter|IPXV_ImportConverter]] | + | [[PXV:IPXV_ImportConverter|IPXV_ImportConverter]] |
Latest revision as of 01:36, 27 April 2017
Checks whether the source data is supported by the converter. If the data format is supported - the FmtCheckRes_OK result is being returned.
Syntax
HRESULT CheckFormat2([in] IPXV_Inst* pInst,
[in] IUnknown* pSrc,
[in] ULONG nFlags,
[out] ICab** pFmtDetails,
[out] IUnknown** pCheckRes,
[out, retval] PXV_FmtCheckResult* pCheckResVal);
Parameters
- pInst
- [in] Pointer to [[PXV:IPXV_Inst| containing the instance of the program.
- pSrc
- [in] Pointer to IUnknown* containing the source data. This should be cast to the data type that is supported by the converter. For example, the Image to PDF converter checks whether this pointer is an IIXC_Image.
- nFlags
- [in] Value of ULONG containing the format check flags.
- pFmtDetails
- [out] Pointer to ICab containing the advanced format details cab node. Created by using the CreateParams method.
- pCheckRes
- [out] Pointer to IUnknown* containing the additional result data.
- pCheckResVal
- [out, retval] Pointer to PXV_FmtCheckResult containing the format check result.
Return Value
Returns S_OK if operation was successful or error code in other cases.
