IPXC_Document::GetNamedDestination Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Document::GetNamedDestination Method}}
 
{{#customTitle:IPXC_Document::GetNamedDestination Method}}
 +
{{#parentPage:PXV:IPXC_Document#Methods|GetNamedDestination|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets [[PXV:PXC_Destination|value]] of the named destination by name.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetNamedDestination([in] BSTR sDestName, [out, retval] PXC_Destination* pDest);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetNamedDestination([in]           BSTR             sDestName,
 +
                            [out, retval] PXC_Destination* stDest);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''sDestName''
+
;sDestName
:[in]  Value of BSTR.
+
:[in]  Name of the named destination.
;''pDest''
+
;stDest
:[out, retval]  Pointer to [[PXV:PXC_Destination|PXC_Destination]].
+
:[out, retval]  Pointer to [[PXV:PXC_Destination|PXC_Destination]] containing the data of the given destination.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Document|IPXC_Document]].
+
[[PXV:IPXC_Document|IPXC_Document]]

Latest revision as of 03:25, 15 June 2015


Gets value of the named destination by name.

Syntax

HRESULT GetNamedDestination([in]           BSTR              sDestName,
                            [out, retval]  PXC_Destination*  stDest);

Parameters

sDestName
[in] Name of the named destination.
stDest
[out, retval] Pointer to PXC_Destination containing the data of the given destination.

Return Value

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

See Also

IPXC_Document