IPXC_Document::GetXMPMetadata Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (7 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Document::GetXMPMetadata Method}} | {{#customTitle:IPXC_Document::GetXMPMetadata Method}} | ||
| − | {{#parentPage:PXV:IPXC_Document|GetXMPMetadata | + | {{#parentPage:PXV:IPXC_Document#Methods|GetXMPMetadata|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Gets document's [[PXV:IPXC_XMPMetadata|XMP Metadata]]. | |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetXMPMetadata([in, defaultvalue(0)] VARIANT_BOOL bCreateIfEmpty, | <pre class="brush:cpp;gutter:false">HRESULT GetXMPMetadata([in, defaultvalue(0)] VARIANT_BOOL bCreateIfEmpty, | ||
| − | [out, retval] IPXC_XMPMetadata** | + | [out, retval] IPXC_XMPMetadata** pXMP);</pre> |
== Parameters == | == Parameters == | ||
;bCreateIfEmpty | ;bCreateIfEmpty | ||
| − | :[in, defaultvalue(0)] Value of VARIANT_BOOL. | + | :[in, defaultvalue(0)] Value of VARIANT_BOOL defining whether the new Metadata should be created. |
| − | ; | + | ;pXMP |
| − | :[out, retval] Pointer to [[PXV:IPXC_XMPMetadata|IPXC_XMPMetadata]]. | + | :[out, retval] Pointer to [[PXV:IPXC_XMPMetadata|IPXC_XMPMetadata]] containing the XMP Metadata. |
== Return Value == | == Return Value == | ||
| Line 21: | Line 21: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_Document|IPXC_Document]] | |
Latest revision as of 06:55, 12 September 2017
Gets document's XMP Metadata.
Syntax
HRESULT GetXMPMetadata([in, defaultvalue(0)] VARIANT_BOOL bCreateIfEmpty,
[out, retval] IPXC_XMPMetadata** pXMP);
Parameters
- bCreateIfEmpty
- [in, defaultvalue(0)] Value of VARIANT_BOOL defining whether the new Metadata should be created.
- pXMP
- [out, retval] Pointer to IPXC_XMPMetadata containing the XMP Metadata.
Return Value
Returns S_OK if operation was successful or error code in other cases.
