IPXC_Document::AuthorizeWithPassword Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Document::AuthorizeWithPassword Method}} | {{#customTitle:IPXC_Document::AuthorizeWithPassword Method}} | ||
| + | {{#parentPage:PXV:IPXC_Document#Methods|AuthorizeWithPassword|method}} | ||
| + | {{ToReview}} | ||
| − | + | 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 == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT AuthorizeWithPassword([in] | + | <pre class="brush:cpp;gutter:false">HRESULT AuthorizeWithPassword([in] LPWSTR sPwd, |
| + | [out, retval] PXC_PermStatus* nStatus);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;sPwd |
| − | :[in] | + | :[in] Password to authorize. |
| − | ; | + | ;nStatus |
| − | :[out, retval] | + | :[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]] | |
Latest revision as of 02:24, 15 June 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 sPwd,
[out, retval] PXC_PermStatus* nStatus);
Parameters
- sPwd
- [in] Password to authorize.
- nStatus
- [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.
