IPXC_Document::SetNamedDestination Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Document::SetNamedDestination Method}}
 
{{#customTitle:IPXC_Document::SetNamedDestination Method}}
{{#parentPage:PXV:IPXC_Document|SetNamedDestination Method|method}}
+
{{#parentPage:PXV:IPXC_Document#Methods|SetNamedDestination|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Sets named destination with given name with new [[PXV:PXC_Destination|value]]. Note that if the given named destination is not in the named destination list it will be created.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT SetNamedDestination([in]  BSTR              pDestName,
+
<pre class="brush:cpp;gutter:false">HRESULT SetNamedDestination([in]  BSTR              sDestName,
                             [in]  PXC_Destination*  pDest);</pre>
+
                             [in]  PXC_Destination*  stDest);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pDestName
+
;sDestName
:[in]  Value of BSTR.
+
:[in]  Name of the named destination that needs to be set with new data.
;pDest
+
;stDest
:[in]  Pointer to [[PXV:PXC_Destination|PXC_Destination]].
+
:[in]  Pointer to [[PXV:PXC_Destination|PXC_Destination]] containing new data of the given destination.
  
 
== Return Value ==
 
== Return Value ==
Line 21: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Document|IPXC_Document]].
+
[[PXV:IPXC_Document|IPXC_Document]]

Latest revision as of 03:26, 15 June 2015


Sets named destination with given name with new value. Note that if the given named destination is not in the named destination list it will be created.

Syntax

HRESULT SetNamedDestination([in]  BSTR              sDestName,
                            [in]  PXC_Destination*  stDest);

Parameters

sDestName
[in] Name of the named destination that needs to be set with new data.
stDest
[in] Pointer to PXC_Destination containing new data of the given destination.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXC_Document