IPXC_Document::AuthorizeWithPassword Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 6: Line 6:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Tries to authorize documents, protected by <tt>Standard</tt> (Password protection) security handler, with specified password. Password specified as regular Unicode string that will be converted to UTF-8 or default ANSI code page depends of document security revision. If document is not protected by <tt>Standard</tt> security, the method will fail.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;pPwd
 
;pPwd
:[in] Value of LPWSTR.
+
:[in] Password to authorize.
 
;pStatus
 
;pStatus
:[out, retval] Pointer to [[PXV:PXC_PermStatus|PXC_PermStatus]].
+
:[out, retval] Returns [[PXV:PXC_PermStatus|PXC_PermStatus]] value that specifies if document was successfully authorized or not.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns <tt>S_OK</tt> if operation was successful or error code in other cases.
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IPXC_Document|IPXC_Document]]
 
[[PXV:IPXC_Document|IPXC_Document]]

Revision as of 18:35, 25 May 2015


Tries to authorize documents, protected by Standard (Password protection) security handler, with specified password. Password specified as regular Unicode string that will be converted to UTF-8 or default ANSI code page depends of document security revision. If document is not protected by Standard security, the method will fail.

Syntax

HRESULT AuthorizeWithPassword([in]           LPWSTR           pPwd,
                              [out, retval]  PXC_PermStatus*  pStatus);

Parameters

pPwd
[in] Password to authorize.
pStatus
[out, retval] Returns PXC_PermStatus value that specifies if document was successfully authorized or not.

Return Value

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

See Also

IPXC_Document