1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>System Information (GNU Octave (version 6.2.0))</title>
<meta name="description" content="System Information (GNU Octave (version 6.2.0))">
<meta name="keywords" content="System Information (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="System-Utilities.html" rel="up" title="System Utilities">
<link href="Hashing-Functions.html" rel="next" title="Hashing Functions">
<link href="Group-Database-Functions.html" rel="prev" title="Group Database Functions">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<span id="System-Information"></span><div class="header">
<p>
Next: <a href="Hashing-Functions.html" accesskey="n" rel="next">Hashing Functions</a>, Previous: <a href="Group-Database-Functions.html" accesskey="p" rel="prev">Group Database Functions</a>, Up: <a href="System-Utilities.html" accesskey="u" rel="up">System Utilities</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="System-Information-1"></span><h3 class="section">36.11 System Information</h3>
<span id="XREFcomputer"></span><dl>
<dt id="index-computer">: <em></em> <strong>computer</strong> <em>()</em></dt>
<dt id="index-computer-1">: <em><var>c</var> =</em> <strong>computer</strong> <em>()</em></dt>
<dt id="index-computer-2">: <em>[<var>c</var>, <var>maxsize</var>] =</em> <strong>computer</strong> <em>()</em></dt>
<dt id="index-computer-3">: <em>[<var>c</var>, <var>maxsize</var>, <var>endian</var>] =</em> <strong>computer</strong> <em>()</em></dt>
<dt id="index-computer-4">: <em><var>arch</var> =</em> <strong>computer</strong> <em>("arch")</em></dt>
<dd><p>Print or return a string of the form <var>cpu</var>-<var>vendor</var>-<var>os</var> that
identifies the type of computer that Octave is running on.
</p>
<p>If invoked with an output argument, the value is returned instead of
printed. For example:
</p>
<div class="example">
<pre class="example">computer ()
-| x86_64-pc-linux-gnu
mycomp = computer ()
⇒ mycomp = x86_64-pc-linux-gnu
</pre></div>
<p>If two output arguments are requested, also return the maximum number of
elements for an array. This will depend on whether Octave has been
compiled with 32-bit or 64-bit index vectors.
</p>
<p>If three output arguments are requested, also return the byte order of the
current system as a character (<code>"B"</code> for big-endian or <code>"L"</code>
for little-endian).
</p>
<p>If the argument <code>"arch"</code> is specified, return a string indicating the
architecture of the computer on which Octave is running.
</p>
<p><strong>See also:</strong> <a href="#XREFisunix">isunix</a>, <a href="#XREFismac">ismac</a>, <a href="#XREFispc">ispc</a>.
</p></dd></dl>
<span id="XREFuname"></span><dl>
<dt id="index-uname">: <em>[<var>uts</var>, <var>err</var>, <var>msg</var>] =</em> <strong>uname</strong> <em>()</em></dt>
<dd><p>Return system information in the structure.
</p>
<p>For example:
</p>
<div class="example">
<pre class="example">uname ()
⇒ {
sysname = x86_64
nodename = segfault
release = 2.6.15-1-amd64-k8-smp
version = Linux
machine = #2 SMP Thu Feb 23 04:57:49 UTC 2006
}
</pre></div>
<p>If successful, <var>err</var> is 0 and <var>msg</var> is an empty string.
Otherwise, <var>err</var> is nonzero and <var>msg</var> contains a
system-dependent error message.
</p></dd></dl>
<span id="XREFnproc"></span><dl>
<dt id="index-nproc">: <em></em> <strong>nproc</strong> <em>()</em></dt>
<dt id="index-nproc-1">: <em></em> <strong>nproc</strong> <em>(<var>query</var>)</em></dt>
<dd><p>Return the current number of available processors.
</p>
<p>If called with the optional argument <var>query</var>, modify how processors
are counted as follows:
</p>
<dl compact="compact">
<dt><code>all</code></dt>
<dd><p>total number of processors.
</p>
</dd>
<dt><code>current</code></dt>
<dd><p>processors available to the current process.
</p>
</dd>
<dt><code>overridable</code></dt>
<dd><p>same as <code>current</code>, but overridable through the
<code><span class="nolinebreak">OMP_NUM_THREADS</span></code><!-- /@w --> environment variable.
</p></dd>
</dl>
</dd></dl>
<span id="XREFispc"></span><dl>
<dt id="index-ispc">: <em></em> <strong>ispc</strong> <em>()</em></dt>
<dd><p>Return true if Octave is running on a Windows system and false otherwise.
</p>
<p><strong>See also:</strong> <a href="#XREFisunix">isunix</a>, <a href="#XREFismac">ismac</a>.
</p></dd></dl>
<span id="XREFisunix"></span><dl>
<dt id="index-isunix">: <em></em> <strong>isunix</strong> <em>()</em></dt>
<dd><p>Return true if Octave is running on a Unix-like system and false otherwise.
</p>
<p><strong>See also:</strong> <a href="#XREFismac">ismac</a>, <a href="#XREFispc">ispc</a>.
</p></dd></dl>
<span id="XREFismac"></span><dl>
<dt id="index-ismac">: <em></em> <strong>ismac</strong> <em>()</em></dt>
<dd><p>Return true if Octave is running on a Mac OS X system and false otherwise.
</p>
<p><strong>See also:</strong> <a href="#XREFisunix">isunix</a>, <a href="#XREFispc">ispc</a>.
</p></dd></dl>
<span id="XREFisieee"></span><dl>
<dt id="index-isieee">: <em></em> <strong>isieee</strong> <em>()</em></dt>
<dd><p>Return true if your computer <em>claims</em> to conform to the IEEE standard
for floating point calculations.
</p>
<p>No actual tests are performed.
</p></dd></dl>
<span id="XREFisdeployed"></span><dl>
<dt id="index-isdeployed">: <em></em> <strong>isdeployed</strong> <em>()</em></dt>
<dd><p>Return true if the current program has been compiled and is running
separately from the Octave interpreter and false if it is running in
the Octave interpreter.
</p>
<p>Currently, this function always returns false in Octave.
</p></dd></dl>
<span id="XREFisstudent"></span><dl>
<dt id="index-isstudent">: <em></em> <strong>isstudent</strong> <em>()</em></dt>
<dd><p>Return true if running in the student edition of <small>MATLAB</small>.
</p>
<p><code>isstudent</code> always returns false in Octave.
</p>
<p><strong>See also:</strong> <a href="Logical-Values.html#XREFfalse">false</a>.
</p></dd></dl>
<span id="XREFOCTAVE_005fHOME"></span><dl>
<dt id="index-OCTAVE_005fHOME">: <em></em> <strong>OCTAVE_HOME</strong> <em>()</em></dt>
<dd><p>Return the name of the top-level Octave installation directory.
OCTAVE_HOME corresponds to the configuration variable <var>prefix</var>.
</p>
<p><strong>See also:</strong> <a href="Controlling-Subprocesses.html#XREFEXEC_005fPATH">EXEC_PATH</a>, <a href="Loading-and-Saving-Images.html#XREFIMAGE_005fPATH">IMAGE_PATH</a>, <a href="#XREFOCTAVE_005fEXEC_005fHOME">OCTAVE_EXEC_HOME</a>.
</p></dd></dl>
<span id="XREFOCTAVE_005fEXEC_005fHOME"></span><dl>
<dt id="index-OCTAVE_005fEXEC_005fHOME">: <em></em> <strong>OCTAVE_EXEC_HOME</strong> <em>()</em></dt>
<dd><p>Return the name of the top-level Octave installation directory for
architecture-dependent files. If not specified separately, the value
is the same as OCTAVE_HOME. OCTAVE_EXEC_HOME corresponds to the
configuration variable <var>exec_prefix</var>.
</p>
<p><strong>See also:</strong> <a href="Controlling-Subprocesses.html#XREFEXEC_005fPATH">EXEC_PATH</a>, <a href="Loading-and-Saving-Images.html#XREFIMAGE_005fPATH">IMAGE_PATH</a>, <a href="#XREFOCTAVE_005fHOME">OCTAVE_HOME</a>.
</p></dd></dl>
<span id="XREFmatlabroot"></span><dl>
<dt id="index-matlabroot">: <em></em> <strong>matlabroot</strong> <em>()</em></dt>
<dd><p>Return the name of the top-level Octave installation directory.
</p>
<p>This is an alias for the function <code><span class="nolinebreak">OCTAVE_HOME</span></code><!-- /@w --> provided for
compatibility.
</p>
<p><strong>See also:</strong> <a href="#XREFOCTAVE_005fHOME">OCTAVE_HOME</a>.
</p></dd></dl>
<span id="XREFOCTAVE_005fVERSION"></span><dl>
<dt id="index-OCTAVE_005fVERSION">: <em></em> <strong>OCTAVE_VERSION</strong> <em>()</em></dt>
<dd><p>Return the version number of Octave as a string.
</p>
<p><strong>See also:</strong> <a href="#XREFver">ver</a>, <a href="#XREFversion">version</a>.
</p></dd></dl>
<span id="XREFversion"></span><dl>
<dt id="index-version">: <em><var>v</var> =</em> <strong>version</strong> <em>()</em></dt>
<dt id="index-version-1">: <em>[<var>v</var>, <var>d</var>] =</em> <strong>version</strong> <em>()</em></dt>
<dt id="index-version-2">: <em><var>v</var> =</em> <strong>version</strong> <em>(<var>feature</var>)</em></dt>
<dd><p>Get version information for Octave.
</p>
<p>If called without input argument, the first return value <var>v</var> gives the
version number of Octave as a string. The second return value <var>d</var> holds
the release date as a string.
</p>
<p>The following options can be passed for <var>feature</var>:
</p>
<dl compact="compact">
<dt><code>"-date"</code></dt>
<dd><p>for the release date of the running build,
</p>
</dd>
<dt><code>"-description"</code></dt>
<dd><p>for a description of the release (always an empty string),
</p>
</dd>
<dt><code>"-release"</code></dt>
<dd><p>for the name of the running build (always an empty string),
</p>
</dd>
<dt><code>"-java"</code></dt>
<dd><p>for version information of the Java VM,
</p>
</dd>
<dt><code>"-fftw"</code></dt>
<dd><p>for version information for the linked <small>FFTW</small>,
</p>
</dd>
<dt><code>"-blas"</code></dt>
<dd><p>for version information for the linked <small>BLAS</small>,
</p>
</dd>
<dt><code>"-lapack"</code></dt>
<dd><p>for version information for the linked <small>LAPACK</small>.
</p>
</dd>
<dt><code>"-hgid"</code></dt>
<dd><p>the mercurial ID of the sources used to build Octave.
</p></dd>
</dl>
<p>The information returned for the <code>"-blas"</code> and <code>"-lapack"</code>
options might be unreliable. It might report which library was linked in
when Octave was built instead of which library is currently used.
</p>
<p>The variant with no input and output argument is an alias for the function
<code><span class="nolinebreak">OCTAVE_VERSION</span></code><!-- /@w --> provided for compatibility.
</p>
<p><strong>See also:</strong> <a href="#XREFOCTAVE_005fVERSION">OCTAVE_VERSION</a>, <a href="#XREFver">ver</a>.
</p></dd></dl>
<span id="XREFver"></span><dl>
<dt id="index-ver">: <em></em> <strong>ver</strong></dt>
<dt id="index-ver-1">: <em></em> <strong>ver</strong> <em>Octave</em></dt>
<dt id="index-ver-2">: <em></em> <strong>ver</strong> <em><var>package</var></em></dt>
<dt id="index-ver-3">: <em>v =</em> <strong>ver</strong> <em>(…)</em></dt>
<dd>
<p>Display a header containing the current Octave version number, license
string, and operating system. The header is followed by a list of installed
packages, versions, and installation directories.
</p>
<p>Use the package name <var>package</var> or Octave to query a specific component.
</p>
<p>When called with an output argument, return a vector of structures
describing Octave and each installed package. Each structure includes the
following fields.
</p>
<dl compact="compact">
<dt><code>Name</code></dt>
<dd><p>Package name.
</p>
</dd>
<dt><code>Version</code></dt>
<dd><p>Version of the package.
</p>
</dd>
<dt><code>Release</code></dt>
<dd><p>Release of the package (currently unused, defaults to <code>[]</code>).
</p>
</dd>
<dt><code>Date</code></dt>
<dd><p>Date that the version was released.
</p></dd>
</dl>
<p><strong>See also:</strong> <a href="#XREFversion">version</a>, <a href="Java-Interface-Functions.html#XREFusejava">usejava</a>, <a href="Installing-and-Removing-Packages.html#XREFpkg">pkg</a>.
</p></dd></dl>
<span id="XREFcompare_005fversions"></span><dl>
<dt id="index-compare_005fversions">: <em></em> <strong>compare_versions</strong> <em>(<var>v1</var>, <var>v2</var>, <var>operator</var>)</em></dt>
<dd><p>Compare two version strings using the given <var>operator</var>.
</p>
<p>This function assumes that versions <var>v1</var> and <var>v2</var> are arbitrarily
long strings made of numeric and period characters possibly followed by an
arbitrary string (e.g., <code>"1.2.3"</code>, <code>"0.3"</code>, <code>"0.1.2+"</code>,
or <code>"1.2.3.4-test1"</code>).
</p>
<p>The version is first split into numeric and character portions and then
the parts are padded to be the same length (i.e., <code>"1.1"</code> would be
padded to be <code>"1.1.0"</code> when being compared with <code>"1.1.1"</code>, and
separately, the character parts of the strings are padded with nulls).
</p>
<p>The operator can be any logical operator from the set
</p>
<ul>
<li> <code>"=="</code>
equal
</li><li> <code>"<"</code>
less than
</li><li> <code>"<="</code>
less than or equal to
</li><li> <code>">"</code>
greater than
</li><li> <code>">="</code>
greater than or equal to
</li><li> <code>"!="</code>, <code>"~="</code>
not equal
</li></ul>
<p>Note that version <code>"1.1-test2"</code> will compare as greater than
<code>"1.1-test10"</code>. Also, since the numeric part is compared first,
<code>"a"</code> compares less than <code>"1a"</code> because the second string
starts with a numeric part even though <code>double ("a")</code> is greater than
<code>double ("1").</code>
</p></dd></dl>
<span id="XREFverLessThan"></span><dl>
<dt id="index-verLessThan">: <em></em> <strong>verLessThan</strong> <em>(<var>package</var>, <var>version</var>)</em></dt>
<dd><p>Return true if the installed version of the package is less than
<var>version</var>.
</p>
<p><var>package</var> is the name of the package to check. Use <code>"Octave"</code> as
the <var>package</var> to check the version of Octave itself.
</p>
<p><var>version</var> is the version to compare it to. A version is a string in the
format accepted by <code>compare_versions</code>: an arbitrarily long string
composed of numeric and period characters, possibly followed by an arbitrary
string (e.g., <code>"1.2.3"</code>, <code>"0.3"</code>, <code>"0.1.2+"</code>, or
<code>"1.2.3.4-test1"</code>).
</p>
<p>Examples:
</p>
<div class="example">
<pre class="example">tf = verLessThan ("Octave", "5")
⇒ tf = 0
tf = verLessThan ("io", "2.4.12")
⇒ ...
if (! verLessThan ("Octave", "5"))
## ... use new Octave 5 features ...
endif
</pre></div>
<p><strong>See also:</strong> <a href="#XREFcompare_005fversions">compare_versions</a>, <a href="#XREFversion">version</a>, <a href="#XREFver">ver</a>, <a href="Installing-and-Removing-Packages.html#XREFpkg">pkg</a>.
</p></dd></dl>
<span id="XREFlicense"></span><dl>
<dt id="index-license">: <em></em> <strong>license</strong></dt>
<dt id="index-license-1">: <em></em> <strong>license</strong> <em>inuse</em></dt>
<dt id="index-license-2">: <em></em> <strong>license</strong> <em>inuse <var>feature</var></em></dt>
<dt id="index-license-3">: <em></em> <strong>license</strong> <em>("inuse")</em></dt>
<dt id="index-license-4">: <em><var>retval</var> =</em> <strong>license</strong> <em>("inuse")</em></dt>
<dt id="index-license-5">: <em><var>retval</var> =</em> <strong>license</strong> <em>("test", <var>feature</var>)</em></dt>
<dt id="index-license-6">: <em><var>retval</var> =</em> <strong>license</strong> <em>("checkout", <var>feature</var>)</em></dt>
<dt id="index-license-7">: <em>[<var>retval</var>, <var>errmsg</var>] =</em> <strong>license</strong> <em>("checkout", <var>feature</var>)</em></dt>
<dd><p>Get license information for Octave and Octave packages.
</p>
<p>GNU Octave is free software distributed under the GNU General Public
License (GPL), and a license manager makes no sense. This function is
provided only for <small>MATLAB</small> compatibility.
</p>
<p>When called with no extra input arguments, it returns the Octave license,
otherwise the first input defines the operation mode and must be one of
the following strings: <code>inuse</code>, <code>test</code>, and <code>checkout</code>.
The optional <var>feature</var> argument can either be <code>"octave"</code> (core),
or an Octave package.
</p>
<dl compact="compact">
<dt><code>"inuse"</code></dt>
<dd><p>Returns a list of loaded features, i.e., octave and the list of loaded
packages. If an output is requested, it returns a struct array with
the fields <code>"feature"</code>, and <code>"user"</code>.
</p>
</dd>
<dt><code>"test"</code></dt>
<dd><p>Return true if the specified <var>feature</var> is installed, false otherwise.
</p>
<p>An optional third argument <code>"enable"</code> or <code>"disable"</code> is
accepted but ignored.
</p>
</dd>
<dt><code>"checkout"</code></dt>
<dd><p>Return true if the specified <var>feature</var> is installed, false otherwise.
An optional second output will have an error message if a package is not
installed.
</p>
</dd>
</dl>
<p><strong>See also:</strong> <a href="Installing-and-Removing-Packages.html#XREFpkg">pkg</a>, <a href="#XREFver">ver</a>, <a href="#XREFversion">version</a>.
</p></dd></dl>
<span id="XREFgetrusage"></span><dl>
<dt id="index-getrusage">: <em></em> <strong>getrusage</strong> <em>()</em></dt>
<dd><p>Return a structure containing a number of statistics about the current
Octave process.
</p>
<p>Not all fields are available on all systems. If it is not possible to get
CPU time statistics, the CPU time slots are set to zero. Other missing data
are replaced by NaN. The list of possible fields is:
</p>
<dl compact="compact">
<dt><code>idrss</code></dt>
<dd><p>Unshared data size.
</p>
</dd>
<dt><code>inblock</code></dt>
<dd><p>Number of block input operations.
</p>
</dd>
<dt><code>isrss</code></dt>
<dd><p>Unshared stack size.
</p>
</dd>
<dt><code>ixrss</code></dt>
<dd><p>Shared memory size.
</p>
</dd>
<dt><code>majflt</code></dt>
<dd><p>Number of major page faults.
</p>
</dd>
<dt><code>maxrss</code></dt>
<dd><p>Maximum data size.
</p>
</dd>
<dt><code>minflt</code></dt>
<dd><p>Number of minor page faults.
</p>
</dd>
<dt><code>msgrcv</code></dt>
<dd><p>Number of messages received.
</p>
</dd>
<dt><code>msgsnd</code></dt>
<dd><p>Number of messages sent.
</p>
</dd>
<dt><code>nivcsw</code></dt>
<dd><p>Number of involuntary context switches.
</p>
</dd>
<dt><code>nsignals</code></dt>
<dd><p>Number of signals received.
</p>
</dd>
<dt><code>nswap</code></dt>
<dd><p>Number of swaps.
</p>
</dd>
<dt><code>nvcsw</code></dt>
<dd><p>Number of voluntary context switches.
</p>
</dd>
<dt><code>oublock</code></dt>
<dd><p>Number of block output operations.
</p>
</dd>
<dt><code>stime</code></dt>
<dd><p>A structure containing the system CPU time used. The structure has the
elements <code>sec</code> (seconds) <code>usec</code> (microseconds).
</p>
</dd>
<dt><code>utime</code></dt>
<dd><p>A structure containing the user CPU time used. The structure has the
elements <code>sec</code> (seconds) <code>usec</code> (microseconds).
</p></dd>
</dl>
</dd></dl>
<span id="XREFwinqueryreg"></span><dl>
<dt id="index-winqueryreg">: <em><var>value</var> =</em> <strong>winqueryreg</strong> <em>(<var>rootkey</var>, <var>subkey</var>, <var>valuename</var>)</em></dt>
<dt id="index-winqueryreg-1">: <em><var>value</var> =</em> <strong>winqueryreg</strong> <em>(<var>rootkey</var>, <var>subkey</var>)</em></dt>
<dt id="index-winqueryreg-2">: <em><var>names</var> =</em> <strong>winqueryreg</strong> <em>(<code>"name"</code>, <var>rootkey</var>, <var>subkey</var>)</em></dt>
<dd>
<p>Query names or value from the Windows registry.
</p>
<p>On Windows, return the value of the registry key <var>subkey</var> from the root key
<var>rootkey</var>. You can specify the name of the queried registry value with the
optional argument <var>valuename</var>. Otherwise, if called with only two
arguments or <var>valuename</var> is empty, then the default value of <var>subkey</var>
is returned. If the registry value is of type <code>"REG_DWORD"</code>
then <var>value</var> is of class int32. If the value is of the type
<code>"REG_SZ"</code> or <code>"REG_EXPAND_SZ"</code> a string is
returned.
</p>
<p>If the first argument is <code>"name"</code>, a cell array of strings with the names
of the values at that key is returned.
</p>
<p>The variable <var>rootkey</var> must be a string with a valid root key identifier:
</p>
<dl compact="compact">
<dt>HKCR</dt>
<dt>HKEY_CLASSES_ROOT</dt>
<dt>HKEY_CURRENT_CONFIG</dt>
<dt>HKCU</dt>
<dt>HKEY_CURRENT_USER</dt>
<dt>HKLM</dt>
<dt>HKEY_LOCAL_MACHINE</dt>
<dt>HKU</dt>
<dt>HKEY_USERS</dt>
<dt>HKEY_PERFORMANCE_DATA</dt>
</dl>
<p>Examples:
</p>
<p>Get a list of value names at the key <code>'HKCU\Environment'</code>:
</p>
<div class="example">
<pre class="example"><var>valuenames</var> = winqueryreg ("name", "HKEY_CURRENT_USER", ...
"Environment");
</pre></div>
<p>For each <var>valuenames</var>, display the value:
</p>
<div class="example">
<pre class="example">for <var>k</var> = 1:numel (<var>valuenames</var>)
<var>val</var> = winqueryreg ("HKEY_CURRENT_USER", "Environment", ...
<var>valuenames</var>{<var>k</var>});
<var>str</var> = sprintf ("%s = %s", <var>valuenames</var>{<var>k</var>}, num2str (<var>val</var>));
disp (<var>str</var>);
endfor
</pre></div>
<p>On non-Windows platforms this function fails with an error.
</p></dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="Hashing-Functions.html" accesskey="n" rel="next">Hashing Functions</a>, Previous: <a href="Group-Database-Functions.html" accesskey="p" rel="prev">Group Database Functions</a>, Up: <a href="System-Utilities.html" accesskey="u" rel="up">System Utilities</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
