IPXV_ImportConverter::CheckFormat2 Method
From PDF XChange PDF SDK
Line 23: | Line 23: | ||
:[in] Value of ULONG containing the [[PXV:PXV_FmtCheckFlags|format check flags]]. | :[in] Value of ULONG containing the [[PXV:PXV_FmtCheckFlags|format check flags]]. | ||
;pFmtDetails | ;pFmtDetails | ||
− | :[out] Pointer to [[PXV:ICab|ICab]] containing the advanced format details cab node. | + | :[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] Pointer to IUnknown* containing the additional result data. | :[out] Pointer to IUnknown* containing the additional result data. |
Latest revision as of 00: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.