getpref

カスタム設定値の取得

構文

prefvalue = getpref(group,pref)

prefvalue = getpref(group,pref,value)

prefvalue = getpref

説明

prefvalue = getpref(group,pref) は、指定したグループの、指定した設定の値を返します。prefvalue には、数値型、文字ベクトル、cell 配列、構造体、オブジェクトなどを含む任意の MATLAB^® データ型を使用できます。pref で複数の設定を指定すると、getpref は cell 配列で値を返します。指定された設定が存在しない場合、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'

入力引数

group — カスタム設定グループ名

文字ベクトル | string スカラー

カスタム設定グループ名。文字ベクトルまたは string スカラーとして指定します。

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

データ型: char | string

pref — カスタム設定名

文字ベクトル | 文字ベクトルの cell 配列 | string 配列

カスタム設定名。文字ベクトル、文字ベクトルの cell 配列、または string 配列として指定します。

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

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

データ型: char | string

value — 設定値

MATLAB データ

設定値。数値型、文字ベクトル、cell 配列、構造体、オブジェクトなどを含む任意の MATLAB データ型として指定します。

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

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

バージョン履歴

R2006a より前に導入

R2025a: [基本設定] ウィンドウの名前を [設定] ウィンドウに変更

[基本設定] ウィンドウの名前は [設定] ウィンドウに変更され、基本設定は設定と呼ばれるようになりました。

参考

関数

• addpref | ispref | rmpref | setpref | uigetpref | uisetpref

ツール

• [設定] ウィンドウ