summaryrefslogtreecommitdiff
path: root/offapi/com
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com')
-rw-r--r--offapi/com/sun/star/util/PathSubstitution.idl4
1 files changed, 3 insertions, 1 deletions
diff --git a/offapi/com/sun/star/util/PathSubstitution.idl b/offapi/com/sun/star/util/PathSubstitution.idl
index 0b30fec48130..c0d99bc9f549 100644
--- a/offapi/com/sun/star/util/PathSubstitution.idl
+++ b/offapi/com/sun/star/util/PathSubstitution.idl
@@ -58,6 +58,8 @@ module com { module sun { module star { module util {
<dd>The current temporary directory.</dd>
<dt>\$(path)</dt>
<dd>The value of PATH environment variable.</dd>
+ <dt>\$(username)</dt>
+ <dd>The username (login name) of the currently active user, excluding the domain name on Windows. (Available since LibreOffice 5.2)</dd>
<dt>\$(langid)</dt>
<dd>The language code used by the Office, like 0x0009=English, 0x0409=English US.</dd>
<dt>\$(vlang)</dt>
@@ -65,7 +67,7 @@ module com { module sun { module star { module util {
</dl>
<p>
Attention: Most predefined variables describe an absolute path.
- The only exceptions are: \$(langid) and \$(vlang).
+ The only exceptions are: \$(username), \$(langid) and \$(vlang).
Therefore the service implementation should only substitute variables which
are located at the start of a provided path string or are part of a multi-path.
This special service is not designed to be a text substiution but shall