IPXC_ActionsList::AddJavaScript 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 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_ActionsList::AddJavaScript Method}}
 
{{#customTitle:IPXC_ActionsList::AddJavaScript Method}}
 +
{{#parentPage:PXV:IPXC_ActionsList#Methods|AddJavaScript|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds new JavaScript action to the actions list.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT AddJavaScript([in] BSTR sScript, [out, retval] IPXC_Action** ppAction);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AddJavaScript([in]           BSTR           pScript,
 +
                      [out, retval] IPXC_Action** ppAction);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''sScript''
+
;pScript
:[in]  Value of BSTR.
+
:[in]  Value of BSTR containing the JavaScript script.
;''ppAction''
+
;ppAction
:[out, retval]  Pointer to [[PXV:IPXC_Action|IPXC_Action]].
+
:[out, retval]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the newly created action.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_ActionsList|IPXC_ActionsList]].
+
[[PXV:IPXC_ActionsList|IPXC_ActionsList]]

Latest revision as of 08:03, 23 May 2015

Adds new JavaScript action to the actions list.

Syntax

HRESULT AddJavaScript([in]           BSTR           pScript,
                      [out, retval]  IPXC_Action**  ppAction);

Parameters

pScript
[in] Value of BSTR containing the JavaScript script.
ppAction
[out, retval] Pointer to IPXC_Action containing the newly created action.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IPXC_ActionsList