{"id":379,"date":"2010-05-31T17:57:21","date_gmt":"2010-05-31T17:57:21","guid":{"rendered":"https:\/\/blogs.mathworks.com\/desktop\/2010\/05\/31\/command-line-preferences\/"},"modified":"2010-05-31T17:57:21","modified_gmt":"2010-05-31T17:57:21","slug":"command-line-preferences","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/community\/2010\/05\/31\/command-line-preferences\/","title":{"rendered":"Command-Line Preferences"},"content":{"rendered":"

I received some criticism regarding my post about using shell command<\/a> because it wasn’t very Desktop-y. The way I see it, the MATLAB Environment includes a broader picture of everything going on around MATLAB, which includes not only the Desktop GUI but also operating system, and anything else you can access. I’m mentioning this to ward off any similar comments for this post about getting\/setting preferences from the command line. To be clear I’m not talking about programmatically setting the Desktop preferences that are controlled from the Preferences GUI, but rather how to add persistent preferences to your own programs through the getpref<\/tt><\/a> and setpref<\/tt><\/a> methods.<\/p>\n

To use the MATLAB preferences functions you need to come up with a “group” name and a preference name. Think of the group as a the toolbox name if you were making your own toolbox. The preference name is the unique key within that group. Unlike the desktop preferences which are stored in the matlab.prf<\/a> text file, the values used by preference mechanism are stored in a MAT-file (matlabprefs.mat). This means that the preferences can be any MATLAB value, not just strings and scalars. Like matlab.prf, the matlabprefs.mat file is stored in your prefdir<\/tt><\/a>.<\/p>\n

Here is an example where I store the URL of my blog as a preference:<\/strong><\/p>\n

%% get the pref with the default value<\/span>\r\nispref('desktop_blog'<\/span>,'url'<\/span>)\r\n% getpref(PREF_GROUP, PREF_NAME, DEFAULT_VALUE)<\/span>\r\ngetpref('desktop_blog'<\/span>,'url'<\/span>,'https:\/\/blogs.mathworks.com\/desktop'<\/span>)<\/pre>\n
\r\nans =\r\n\r\n     0\r\n\r\n\r\nans =\r\n\r\nhttps:\/\/blogs.mathworks.com\/desktop\r\n\r\n<\/pre>\n
%% change the pref to point to the MATLAB Central Main page<\/span>\r\nsetpref('desktop_blog'<\/span>,'url'<\/span>,'http:\/\/www.matlabcentral.com'<\/span>)\r\nispref('desktop_blog'<\/span>,'url'<\/span>)\r\ngetpref('desktop_blog'<\/span>,'url'<\/span>,'https:\/\/blogs.mathworks.com\/desktop'<\/span>)<\/pre>\n
\r\nans =\r\n\r\n     1\r\n\r\n\r\nans =\r\n\r\nhttp:\/\/www.matlabcentral.com\r\n\r\n<\/pre>\n
%% reset the pref<\/span>\r\nrmpref('desktop_blog'<\/span>,'url'<\/span>)\r\nispref('desktop_blog'<\/span>,'url'<\/span>)<\/pre>\n
\r\nans =\r\n\r\n     0\r\n\r\n<\/pre>\n
%% how might this be used?<\/span>\r\nweb(getpref('desktop_blog'<\/span>,'url'<\/span>,'https:\/\/blogs.mathworks.com\/desktop'<\/span>))<\/pre>\n
Just so you don’t get confused when looking around the documentation, there’s also an addpref<\/tt><\/a> which as far as I can tell does the same thing as setpref<\/tt> except throw an exception if the preference group and name already exist. There’s also a ui(get\/set)pref<\/tt> which seems to me to just be a generic dialog that the user can set a preference whether or not that specific dialog is shown again; the command does not explicitly create a dialog to get or set a specific preference. You can easily build such a UI with the (get\/set)pref functions and GUIDE or any of the dialog functions<\/a>.<\/p>\n
David Schwartz, one of Loren’s readers<\/a> uses getpref<\/tt> to save\/restore the last current working directory between MATLAB sessions. How do you or might you use these preferences functions?<\/p>\n","protected":false},"excerpt":{"rendered":"
I received some criticism regarding my post about using shell command because it wasn’t very Desktop-y. The way I see it, the MATLAB Environment includes a broader picture of everything going… read more >><\/a><\/p>\n","protected":false},"author":38,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/posts\/379"}],"collection":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/users\/38"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/comments?post=379"}],"version-history":[{"count":0,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/posts\/379\/revisions"}],"wp:attachment":[{"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/media?parent=379"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/categories?post=379"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.mathworks.com\/community\/wp-json\/wp\/v2\/tags?post=379"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}