:: com :: sun :: star :: util ::
|
service PathSubstitution |
- Description
- A service to support the substitution and resubstitution of path variables.
A path variable must be specified with the following syntax: "$("<variable-name>")".
Path variables are not case sensitive and are always provided as a UCB-compliant URLs
(for example: "file:///c:/temp" or "file:///usr/install"). This is mandatory to support an
optional remote file system.
A user defined list of path variables is supported. This list is stored in the Office
configuration file (org/openoffice/Office/Substitution.xml). Please have a look at the
schema definition file which configuration structure this file uses.
There is also a set of variables that have pre-defined values:
- $(inst)
- Installation path of the Office Basis layer.
- $(prog)
- Program path of the Office Basis layer.
- $(brandbaseurl)
- Installation path of the the Office Brand layer.
- $(user)
- The user installation directory.
- $(work)
- The work directory of the user. Under Windows this would be the
"MyDocuments" subdirectory. Under Unix this would be the home-directory
- $(home)
- The home directory of the user. Under Unix this would be the home-
directory. Under Windows this would be the "Documents and Settings\"
subdirectory.
- $(temp)
- The current temporary directory.
- $(path)
- The value of PATH environment variable.
- $(lang)
- The country code used by the Office, like 01=English, 49=German.
- $(langid)
- The language code used by the Office, like 0x0009=English, 0x0409=English US.
- $(vlang)
- The language used by the Office as a string. Like "German" for a German Office.
Attention: Most predefined variables describe an absolute path.
The only exceptions are: $(lang), $(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
provide (a) valid substituted path(s).
- Since
- OOo 1.1.2
|
Exported Interfaces - Summary |
XStringSubstitution |
Interface to exchange path variables with defined paths and to resubstitute paths with path variables.
(details)
|
Exported Interfaces - Details |
XStringSubstitution
- Description
- Interface to exchange path variables with defined paths and to resubstitute paths with path variables.
To resubstitute path variables the caller must provide paths as UCB-compliant URLs.
|
|
Top of Page
Copyright © 1995, 2012, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.