IPXV_ImportConverter::CheckFormat Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (4 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_ImportConverter::CheckFormat Method}} | {{#customTitle:IPXV_ImportConverter::CheckFormat Method}} | ||
| − | {{#parentPage:PXV:IPXV_ImportConverter#Methods|CheckFormat | + | {{#parentPage:PXV:IPXV_ImportConverter#Methods|CheckFormat|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 CheckFormat([in] IPXV_Inst* | + | <pre class="brush:cpp;gutter:false">HRESULT CheckFormat([in] IPXV_Inst* pInst, |
| − | [in] IUnknown* | + | [in] IUnknown* pSrc, |
| − | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG nFlags, |
| − | [out, retval] | + | [out, retval] PXV_FmtCheckResult* pCheckResVal);</pre> |
== Parameters == | == Parameters == | ||
;pInst | ;pInst | ||
| − | :[in] Pointer to [[PXV:IPXV_Inst|IPXV_Inst]]. | + | :[in] Pointer to [[PXV:IPXV_Inst|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, defaultvalue(0)] Value of ULONG. | + | :[in, defaultvalue(0)] Value of ULONG containing the [[PXV:PXV_FmtCheckFlags|format check flags]]. |
| − | ; | + | ;pCheckResVal |
| − | :[out, retval] Pointer to [[PXV: | + | :[out, retval] Pointer to [[PXV:PXV_FmtCheckResult|PXV_FmtCheckResult]] containing the result of the format check. |
== Return Value == | == Return Value == | ||
| Line 28: | Line 27: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXV_ImportConverter|IPXV_ImportConverter]] | + | [[PXV:IPXV_ImportConverter|IPXV_ImportConverter]] |
Latest revision as of 00:26, 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 CheckFormat([in] IPXV_Inst* pInst,
[in] IUnknown* pSrc,
[in, defaultvalue(0)] ULONG nFlags,
[out, retval] PXV_FmtCheckResult* pCheckResVal);
Parameters
- pInst
- [in] Pointer to 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, defaultvalue(0)] Value of ULONG containing the format check flags.
- pCheckResVal
- [out, retval] Pointer to PXV_FmtCheckResult containing the result of the format check.
Return Value
Returns S_OK if operation was successful or error code in other cases.
