getpref

获取自定义设置值

全页折叠

语法

prefvalue = getpref(group,pref)
prefvalue = getpref(group,pref,value)
prefvalue = getpref

说明

prefvalue = getpref(group,pref) 返回指定组中指定设置的值。prefvalue 可以是任何 MATLAB® 数据类型，包括数值类型、字符向量、元胞数组、结构体和对象。如果 pref 指定多个设置，则 getpref 以元胞数组形式返回值。如果指定的设置不存在，MATLAB 将返回错误。

示例

如果设置不存在，prefvalue = getpref(group,pref,value) 将使用指定的默认值创建指定的设置，然后返回该值。如果设置存在，getpref 将返回当前值。

示例

prefvalue = getpref 以结构体形式返回所有自定义组和设置。

示例

全部折叠

将名为 version 的设置添加到 mytoolbox 设置组中，然后获取该设置值。

addpref("mytoolbox","version","1.0")
getpref("mytoolbox","version")
ans =
    '1.0'

获取 mytoolbox 设置组中名为 name 的设置的值。由于该设置不存在，MATLAB 将使用指定值创建该设置并返回该值。

getpref("mytoolbox","name","My Very Cool Toolbox")
ans =
    'My Very Cool Toolbox'

输入参数

全部折叠

自定义设置组名称，指定为字符向量或字符串标量。

示例: getpref('mytoolbox','version')

数据类型: char | string

自定义设置名称，指定为字符向量、字符向量元胞数组或字符串数组。

示例: getpref('mytoolbox','version')

示例: getpref('mytoolbox',{'version','modifieddate','docpath'})

数据类型: char | string

设置值，指定为任何类型的 MATLAB 数据，包括数值类型、字符向量、元胞数组、结构体和对象。

示例: getpref('mytoolbox','version','v1.1.2')

示例: getpref('mytoolbox',{'version','modifieddate','docpath'},{'v1.2.2','09/09/2019','C:\mytoolbox\documentation'})

版本历史记录

在 R2006a 之前推出

全部展开

另请参阅

函数

工具