summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorTsutomu Uchino <hanya@apache.org>2015-01-16 17:02:52 +0000
committerTsutomu Uchino <hanya@apache.org>2015-01-16 17:02:52 +0000
commitabaff3a9330500a7394767081bfb52788028ff0c (patch)
treece3a65fde2fe83f0418afc2590cb71c1cc0ae777 /offapi
parent82f67031551c3e153b5977d2cc40ce68dda68ba0 (diff)
#i34459# add description about IllegalArgumentException thrown by unprotect method and about some arguments
Notes
Notes: merged as: b698b9362b1a4ab58e0307a20f65dea796087344
Diffstat (limited to 'offapi')
-rw-r--r--offapi/com/sun/star/util/XProtectable.idl8
1 files changed, 8 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XProtectable.idl b/offapi/com/sun/star/util/XProtectable.idl
index d794e90ac301..6bb590a42d1d 100644
--- a/offapi/com/sun/star/util/XProtectable.idl
+++ b/offapi/com/sun/star/util/XProtectable.idl
@@ -44,11 +44,19 @@ published interface XProtectable: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** activates the protection.
+
+ @param aPassword
+ a string to specify new password.
*/
void protect( [in] string aPassword );
//-------------------------------------------------------------------------
/** removes the protection.
+
+ @param aPassword
+ a string to match with the current password.
+ @throws com::sun::star::lang::IllegalArgumentException
+ if invalid password is specified.
*/
void unprotect( [in] string aPassword )
raises( com::sun::star::lang::IllegalArgumentException );