Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
5.5.1 - English

Change language to:
Français - 日本語 - Português - Русский

Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
However, this page did not exist in the previous stable version.

Scilab Help >> Preferences > getPreferencesValue

getPreferencesValue

Get preferences value

Calling Sequence

getPreferencesValue(xpath, attributes [, doc])

Arguments

xpath

a string, represents the XPath request to get the node in the preferences file.

attributes

a matrix of strings, the attributes names.

doc

a mlist typed XMLDoc, the XML document associated to the preference file.

Description

Get the values of the attributes in preferences file (SCIHOME+'/XConfiguration.xml').

When doc is specified, the values are searched in this document. It is useful when several requests need to be done to avoid to parse again and again the same configuration file.

All valid XPath requests are possible. For example to write the XPath request to get proxy settings:

  • Open the file SCIHOME+'/XConfiguration.xml' and gets the nodes names to access to the expected node:

    <?xml version="1.0" encoding="utf-8" standalone="no"?>
    <interface height="600" path="1/" version="0.17" width="800">
        <general title="_(General)">
        ...
        </general>
        <web title="_(Web)">
            <body>
                <web command-browser="" command-mailer="" default-browser="true" default-mailer="true"/>
                <proxy enabled="false" host="" password="" port="" user=""/>
                <previous-proxy enabled="false" host="" password="" port="" user=""/>
            </body>
        </web>
        ...
    </interface>

    The path will be "/interface/web/body/proxy" (or to simplify "//web/body/proxy").

Examples

getPreferencesValue("//web/body/proxy", ["enabled", "host", "port"]);

See Also

Report an issue
<< Preferences Preferences preferences >>

Copyright (c) 2022-2024 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Thu Oct 02 13:47:02 CEST 2014