このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

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'

入力引数

すべて折りたたむ

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

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

データ型: char | string

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

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

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

データ型: char | string

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

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

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

バージョン履歴

R2006a より前に導入

参考

| | | | | |