userpath

既定のユーザーの作業フォルダーを表示または変更

ページ内をすべて折りたたむ

構文

userpath
userpath(newpath)
userpath("reset")
userpath("clear")

説明

userpath は、MATLAB® が起動時に検索パスに追加するユーザー固有のフォルダーを返します。関数はフォルダーを文字ベクトルとして返します。検索パスの詳細については、MATLAB 検索パスとはを参照してください。

MATLAB の起動オプションを構成する場合の詳細については、MATLAB 起動ファイルでの起動オプションの指定を参照してください。

例

userpath(newpath) は、検索パスのユーザー固有のフォルダーを newpath に設定します。指定したフォルダーは、直後および今後のセッションの起動時に検索パスに置かれます。MATLAB は、userpath によって前に指定されたフォルダーを検索パスから削除します。

例

userpath("reset") は、検索パスのユーザー固有のフォルダーをプラットフォームの既定値に設定します。既定の userpath フォルダーはプラットフォームによって異なります。

  • Windows® プラットフォーム — %USERPROFILE%\Documents\MATLAB

  • Mac プラットフォーム — $home/Documents/MATLAB

  • Linux® プラットフォーム — $HOME/Documents/MATLAB ($HOME/Documents が存在する場合)。$HOME/Documents が存在しない場合は、関数は [] を返し、有効なパスは設定されません。

MATLAB は、既定のフォルダーを直ちに検索パスに追加するだけでなく、それ以降のセッションの起動時にも検索パスに追加します。Windows および Mac プラットフォームでは、既定のフォルダーが存在しない場合は作成されます。Linux では、既定のフォルダーが存在しない場合は作成されません。

userpath("clear") は直ちに検索パスからユーザー固有のフォルダーを削除し、それ以降の MATLAB セッションでもこのフォルダーは検索されません。

例

例

すべて折りたたむ

この例では、userpath フォルダーが Windows プラットフォーム上で既定値 Documents\MATLAB に設定されていると仮定します。MATLAB を起動すると、現在のフォルダーが表示されます。

pwd
H:\Documents\MATLAB

この例で H は Documents があるドライブです。

現在のフォルダーが userpath フォルダーであることを確認します。

userpath
H:\Documents\MATLAB

検索パスを表示します。MATLAB は、userpath によって指定されたフォルダーを含む検索パスを返します。

path
MATLABPATH

	H:\Documents\MATLAB
	C:\Program Files\MATLAB\R2009a\toolbox\matlab\general
	C:\Program Files\MATLAB\R2009a\toolbox\matlab\ops
...

userpath フォルダーが Windows プラットフォームの既定値 Documents\MATLAB に設定されていると仮定します。

この値を既定値から C:\Research_Project に変更します。

newpath = "C:\Research_Project";
userpath(newpath)

検索パスを表示して変更の影響を確認します。

path
MATLABPATH

	C:\Research_Project
	C:\Program Files\MATLAB\R2009a\toolbox\matlab\general
	C:\Program Files\MATLAB\R2009a\toolbox\matlab\ops
...

MATLAB は、userpath によって指定されたフォルダーを含む検索パスを表示します。MATLAB は、userpath を使用して新しいフォルダーが割り当てられると、自動的に userpath フォルダーの以前の値 H:\Documents\MATLAB を検索パスから削除します。

userpath フォルダーが既定値に設定されているが、起動時に検索パスに追加しないようにすると仮定します。

既定値が設定されていることを確認します。

userpath
H:\Documents\MATLAB

検索パス上にあることを確認します。

path
MATLABPATH

H:\Documents\MATLAB
C:\Program Files\MATLAB\R2009a\toolbox\matlab\general
C:\Program Files\MATLAB\R2009a\toolbox\matlab\ops
...

値をクリアします。

userpath("clear")

結果を確認します。

userpath
ans =
     ''

以前の userpath フォルダーが検索パスから削除されていることを確認します。

path
MATLABPATH

C:\Program Files\MATLAB\R2009a\toolbox\matlab\general
C:\Program Files\MATLAB\R2009a\toolbox\matlab\ops
...

メモ

userpath("clear") を使用した場合、起動フォルダーが検索パス上にない可能性があります。この状況は、userpath フォルダーを検索パスから削除し、変更を保存した場合にも生じることがあります。

入力引数

すべて折りたたむ

userpath フォルダーの新しい値。string スカラーまたは文字ベクトルとして指定します。newpath は絶対パスでなければなりません。

例: "C:\myFolder"

制限

  • MATLAB Online™ では、"userpath" フォルダーの表示のみ可能です。フォルダーの変更はサポートされていません。

ヒント

  • 起動フォルダーを指定するには、[設定] ウィンドウの [一般設定] ページにある [初期作業フォルダー] 設定を設定します。userpath を初期作業フォルダーとして使用する場合の詳細については、userpath を初期作業フォルダーに使用を参照してください。

  • MATLABPATH 環境変数に、検索パスに追加するフォルダーのリストを含めることができます。MATLAB は、MATLABPATH 環境変数で指定したフォルダーを、起動時に userpath フォルダーの下の検索パスに追加します。

バージョン履歴

R2008a で導入

参考

関数

ツール

トピック