IAFS_BindContext::OnPrompt Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IAFS_BindContext::OnPrompt Method}}
 
{{#customTitle:IAFS_BindContext::OnPrompt Method}}
{{#parentPage:PXV:IAFS_BindContext#Methods|OnPrompt Method|method}}
+
{{#parentPage:PXV:IAFS_BindContext#Methods|OnPrompt|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
Called, by the file system, to show a prompt to a user.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT OnPrompt(  IAFS_BindPromptCallback*  pCb);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT OnPrompt([in] IAFS_BindPromptCallback*  pCb);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pCb
 
;pCb
: Pointer to [[PXV:IAFS_BindPromptCallback|IAFS_BindPromptCallback]].
+
: Interface of the callback object, provided by the file system, to show a prompt to a user.
  
 
== 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, otherwise an error code is returned.
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IAFS_BindContext|IAFS_BindContext]]
 
[[PXV:IAFS_BindContext|IAFS_BindContext]]

Latest revision as of 23:49, 30 November 2017

Called, by the file system, to show a prompt to a user.

Syntax

HRESULT OnPrompt([in]  IAFS_BindPromptCallback*  pCb);

Parameters

pCb
Interface of the callback object, provided by the file system, to show a prompt to a user.

Return Value

Returns S_OK if the operation was successful, otherwise an error code is returned.

See Also

IAFS_BindContext