0% found this document useful (0 votes)
9 views1,500 pages

Labview Programming Reference Manual 7-30-2024!1!3000-0001-1500

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
9 views1,500 pages

Labview Programming Reference Manual 7-30-2024!1!3000-0001-1500

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1500

LabVIEW

Programming
Reference
Manual

2024-07-29
LabVIEW Programming Reference Manual

Contents
LabVIEW Programming Reference Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
For Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
While Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Timed Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Timed Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Timed Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Create Timing Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Create 1kHz Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Create 1MHz Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Create Software-Triggered Timing Source . . . . . . . . . . . . . . . . . . 352
Fire Software-Triggered Timing Source . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Clear Timing Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Synchronize Timed Structure Starts . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Stop Timed Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Build Timing Source Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Case Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Event Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
In Place Element Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Array Index / Replace Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Unbundle / Bundle Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Variant To / From Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
In Place In / Out Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Waveform Unbundle / Bundle Elements . . . . . . . . . . . . . . . . . . . . . . . . . 368
Data Value Reference Read / Write Element . . . . . . . . . . . . . . . . . . . . . . 369
Array Split / Replace Subarrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Variant Attribute Get / Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Map Get / Replace Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Flat Sequence Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Formula Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

2 ni.com
LabVIEW Programming Reference Manual

Diagram Disable Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378


Conditional Disable Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Type Specialization Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Local Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Global Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Decorations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Feedback Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Array Size Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Index Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Replace Array Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Insert Into Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Delete From Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Initialize Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Build Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Array Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Array Max & Min Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Reshape Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Sort 1D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Sort 2D Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Shuffle 1D Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Shuffle 2D Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Reverse 1D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Search 1D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Split 1D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Rotate 1D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Increment Array Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Decrement Array Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Interpolate 1D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Threshold 1D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Interleave 1D Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Decimate 1D Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Transpose 2D Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Array Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Array To Cluster Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

© National Instruments 3
LabVIEW Programming Reference Manual

Cluster To Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422


Array To Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Array To Matrix - RA2 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Array To Matrix - RA VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Array To Matrix - CA2 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Array To Matrix - CA VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Matrix To Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Matrix To Array - RM VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Matrix To Array - CM VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Remove Duplicates From 1D Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Unsorted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Search Unsorted 1D Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Sort 1D Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Sorted Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Search Sorted 1D Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Insert Into Sorted Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Matrix Size Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Build Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Resize Matrix Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Transpose Matrix Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Get Matrix Diagonal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Get Matrix Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Get Submatrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Set Matrix Diagonal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
Set Matrix Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Set Submatrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Cluster, Class, & Variant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Unbundle By Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Bundle By Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Unbundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Bundle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Cluster Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Build Cluster Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Index & Bundle Cluster Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Cluster To Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

4 ni.com
LabVIEW Programming Reference Manual

Array To Cluster Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465


Call Parent Class Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
To More Specific Class Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
To More Generic Class Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Preserve Run-Time Class Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
LV Object Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Get LV Class Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
Get LV Class Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Get LV Class Default Value By Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Get LV Class Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Variant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
To Variant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Variant To Data Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Variant Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Flattened String To Variant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Variant To Flattened String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Get Variant Attribute Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Set Variant Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
Delete Variant Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Data Type Parsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Get Type Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Get Array Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Get Cluster Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Is Error Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
Get Numeric Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Get Fixed-Point Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
Get Waveform Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Get Channel Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Get Refnum Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Get User-Defined Refnum Information . . . . . . . . . . . . . . . . . . . . . 497
Get User-Defined Tag Information . . . . . . . . . . . . . . . . . . . . . . . . . 499
Get Tag Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Get VI Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Get Polymorphic VI Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Get Map Collection Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Get Set Collection Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

© National Instruments 5
LabVIEW Programming Reference Manual

Get Type Definition Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505


Is or Contains Type Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Disconnect Type Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Check for Contained Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Get LabVIEW Class Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Get LabVIEW Class Parent And Member VI Information . . . . . . . 510
Numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Add Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
Subtract Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
Multiply Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
Divide Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
Quotient & Remainder Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
To Extended Precision Float Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
To Double Precision Float Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
To Single Precision Float Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
To Fixed-Point Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
To Quad Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
To Long Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
To Word Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
To Byte Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
To Unsigned Quad Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
To Unsigned Long Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
To Unsigned Word Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
To Unsigned Byte Integer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
To Extended Precision Complex Function . . . . . . . . . . . . . . . . . . . . . . . 533
To Double Precision Complex Function . . . . . . . . . . . . . . . . . . . . . . . . . 534
To Single Precision Complex Function . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Coerce To Type Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Number To Boolean Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Boolean Array To Number Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
Boolean To (0,1) Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
To Time Stamp Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
String To Byte Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Byte Array To String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Convert Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540

6 ni.com
LabVIEW Programming Reference Manual

Cast Unit Bases Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541


Color to RGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
RGB to Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Enum to Array of Enums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Increment Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Decrement Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
Add Array Elements Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Multiply Array Elements Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Compound Arithmetic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Data Manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Type Cast Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Flatten To String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Unflatten From String Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Mantissa & Exponent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Rotate Left With Carry Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Rotate Right With Carry Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Logical Shift Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Rotate Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
Split Number Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Join Numbers Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Swap Bytes Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Swap Words Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Byte Array Checksum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
SHA-256 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . 565
SHA-224 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . 566
SHA-384 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . 566
SHA-512 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . 567
SHA-512-256 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . 567
SHA-512-224 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . 568
SHA3-224 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . 568
SHA3-256 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . 569
SHA3-384 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . 569
SHA3-512 Byte Array Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . 570
Absolute Value Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Round To Nearest Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Round Toward -Infinity Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573

© National Instruments 7
LabVIEW Programming Reference Manual

Round Toward +Infinity Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573


Scale By Power Of 2 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Complex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
Complex Conjugate Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Polar To Complex Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
Complex To Polar Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Re/Im To Complex Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
Complex To Re/Im Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Re/Im To Polar Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Polar To Re/Im Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Square Root Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Square Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Negate Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Reciprocal Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Sign Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Convert RTD Reading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Convert RTD Reading (waveform) VI . . . . . . . . . . . . . . . . . . . . . . . 588
Convert RTD Reading (scaler) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Convert Strain Gauge Reading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
Convert Strain Gauge Reading (waveform) VI . . . . . . . . . . . . . . . 593
Convert Strain Gauge Reading (scaler) VI . . . . . . . . . . . . . . . . . . . 597
Convert Thermistor Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Convert Thermistor Reading (waveform) VI . . . . . . . . . . . . . . . . . 602
Convert Thermistor Reading (scaler) VI . . . . . . . . . . . . . . . . . . . . . 605
Convert Thermocouple Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Convert Thermocouple Reading (waveform) VI. . . . . . . . . . . . . . 608
Convert Thermocouple Reading (array) VI . . . . . . . . . . . . . . . . . . 610
Convert Thermocouple Reading (scaler) VI . . . . . . . . . . . . . . . . . 612
Radians to Degrees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Degrees to Radians . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
RPM to Radians per Second . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Radians per Second to RPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Numeric Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Enum Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Ring Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617

8 ni.com
LabVIEW Programming Reference Manual

Random Number (0-1) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618


Random Number (Range) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Random Number (Range) U64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Random Number (Range) I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Random Number (Range) DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Fixed-Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Fixed-Point to Integer Cast Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Integer to Fixed-Point Cast Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Clear Fixed-Point Overflow Status Function . . . . . . . . . . . . . . . . . . . . . . 624
Remove Fixed-Point Overflow Status Function . . . . . . . . . . . . . . . . . . . 625
Include Fixed-Point Overflow Status Function . . . . . . . . . . . . . . . . . . . 625
DBL Numeric Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Positive Infinity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Machine Epsilon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Not A Number Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Math & Scientific Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Range Limits for Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Expression Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Boolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
And Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Or Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Exclusive Or Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Not Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Not And Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Not Or Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638
Not Exclusive Or Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Implies Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
And Array Elements Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
Or Array Elements Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
Number To Boolean Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
Boolean Array To Number Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
Boolean To (0,1) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
True Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
False Constant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
String Length Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649

© National Instruments 9
LabVIEW Programming Reference Manual

Concatenate Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649


String Subset Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Trim Whitespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Normalize End Of Line. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Replace Substring Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Search and Replace String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Match Pattern Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Match Regular Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Path/Array/String Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Path to Array of Strings Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Array of Strings to Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Path To String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
String To Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
String To Byte Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Byte Array To String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Scan From String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Format Into String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Format Date/Time String Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Build Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
............................................................. 679
Number/String Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
Number To Decimal String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
Number To Hexadecimal String Function . . . . . . . . . . . . . . . . . . . . . . . . 684
Number To Octal String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Number To Fractional String Function . . . . . . . . . . . . . . . . . . . . . . . . . . 685
Number To Exponential String Function . . . . . . . . . . . . . . . . . . . . . . . . . 687
Number To Engineering String Function . . . . . . . . . . . . . . . . . . . . . . . . . 688
Format Value Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
Decimal String To Number Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Hexadecimal String To Number Function . . . . . . . . . . . . . . . . . . . . . . . . 691
Octal String To Number Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
Fract/Exp String To Number Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Scan Value Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
Spreadsheet String To Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
Array To Spreadsheet String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
To Upper Case Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701

10 ni.com
LabVIEW Programming Reference Manual

To Lower Case Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702


Flatten/Unflatten String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
Flatten To String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Unflatten From String Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Variant To Flattened String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Flattened String To Variant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Flatten To XML Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
Unflatten From XML Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
Flatten To JSON Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
Unflatten From JSON Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
String Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Empty String Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
Space Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Tab Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Additional String Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
Search/Split String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
Pick Line Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Match First String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Match True/False String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
Scan String For Tokens Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
Search and Replace Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Index String Array Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Append True/False String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Rotate String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Reverse String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
Delimited String to 1D String Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
1D String Array to Delimited String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Create NI GUID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
ASCII Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Format Codes for the Time Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
Carriage Return Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Line Feed Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
End of Line Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
Not Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747

© National Instruments 11
LabVIEW Programming Reference Manual

Greater? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748


Less? Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
Greater Or Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
Less Or Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Not Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Greater Than 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
Less Than 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Greater Or Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
Less Or Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Select Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
Max & Min Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
In Range and Coerce Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Not A Number/Path/Refnum? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
Empty Array? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Empty String/Path? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
Decimal Digit? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Hex Digit? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Octal Digit? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
Printable? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763
White Space? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Lexical Class Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
............................................................. 771
Assert Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Type Specialization Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
Assert Structural Type Match Function . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Assert Structural Type Mismatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
Assert Error Cluster Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
Assert Array Dimension Count VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Assert Array Dimension Sizes VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Assert Same or Descendant Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
Assert Scalar Numeric Or Waveform Type VI . . . . . . . . . . . . . . . . . . . . . 784
Assert Scalar Numeric Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Assert Real Numeric Or Waveform Type VI . . . . . . . . . . . . . . . . . . . . . . . 786
Assert Real Numeric Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786

12 ni.com
LabVIEW Programming Reference Manual

Assert Fractional Numeric Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787


Assert Complex Numeric Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Assert Floating-Point Numeric Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Assert Real Floating-Point Numeric Type VI . . . . . . . . . . . . . . . . . . . . . . 789
Assert Integer Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Assert Signed Integer Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
Assert Unsigned Integer Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
Assert Fixed-Point Numeric Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Is Value Changed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
Is Path and Not Empty? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Fixed-Point Overflow? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
Get Waveform Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Build Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
Set Waveform Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 798
Get Waveform Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
Analog to Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
DWDT Analog to Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
DTbl Analog to Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Digital to Analog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
DWDT Digital to Analog VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
DTbl Digital to Analog VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Index Waveform Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
WDT Index Channel DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
WDT Index Channel I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
WDT Index Channel I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
WDT Index Channel I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
WDT Index Channel CDB VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
WDT Index Channel by Name DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
WDT Index Channel by Name I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
WDT Index Channel by Name I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 822
WDT Index Channel by Name I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
WDT Index Channel by Name CDB VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
DWDT Index Channel VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826
DWDT Index Channel by Name VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
Copy Waveform dt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828

© National Instruments 13
LabVIEW Programming Reference Manual

WDT Copy Waveform dt DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828


WDT Copy Waveform dt I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
WDT Copy Waveform dt I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
WDT Copy Waveform dt I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831
WDT Copy Waveform dt CDB VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
WDT Copy Waveform dt EXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
WDT Copy Waveform dt CXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
DWDT Copy Waveform dt VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
Align Waveform Timestamps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
WDT Align Waveform Timestamps DBL VI . . . . . . . . . . . . . . . . . . . . . . . . 836
WDT Align Waveform Timestamps I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . 837
WDT Align Waveform Timestamps I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . 838
WDT Align Waveform Timestamps I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . 839
WDT Align Waveform Timestamps CDB VI . . . . . . . . . . . . . . . . . . . . . . . 840
WDT Align Waveform Timestamps EXT VI . . . . . . . . . . . . . . . . . . . . . . . . 841
WDT Align Waveform Timestamps CXT VI . . . . . . . . . . . . . . . . . . . . . . . . 842
DWDT Align Waveform Timestamps VI. . . . . . . . . . . . . . . . . . . . . . . . . . . 843
Get Waveform Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
WDT Get Waveform Subset DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
WDT Get Waveform Subset CDB VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
WDT Get Waveform Subset EXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
WDT Get Waveform Subset I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 850
WDT Get Waveform Subset I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
WDT Get Waveform Subset I8 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
WDT Get Waveform Subset SGL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
DWDT Get Waveform Subset VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
DTbl Digital Subset VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
Get Final Time Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
WDT Get Final Time Value DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
DWDT Get Final Time Value VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Waveform Duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
WDT Waveform Duration DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
DWDT Waveform Duration VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 866
Scale Delta t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
WDT Scale Delta t DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
WDT Scale Delta t SGL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869

14 ni.com
LabVIEW Programming Reference Manual

WDT Scale Delta t I64 VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870


WDT Scale Delta t I32 VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 871
WDT Scale Delta t I16 VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
WDT Scale Delta t CDB VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
WDT Scale Delta t EXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 873
DWDT Scale Delta t VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
Get XY Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
WDT Get XY Value DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
WDT Get XY Value I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
WDT Get XY Value I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
WDT Get XY Value I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
WDT Get XY Value CDB VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
WDT Get XY Value EXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
WDT Get XY Value CXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
DWDT Get XY Value VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
DTbl Get Digital Value VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
Get Waveform Time Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
WDT Get Waveform Time Array DBL VI. . . . . . . . . . . . . . . . . . . . . . . . . . . 891
DWDT Get Waveform Time Array VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
Analog Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Get Waveform Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
Build Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Set Waveform Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
Get Waveform Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
Waveform Scale and Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Normalize Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
Append Waveforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
WDT Append Waveforms DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
WDT Append Waveforms I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
WDT Append Waveforms I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
WDT Append Waveforms I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
WDT Append Waveforms CDB VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
WDT Append Waveforms EXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
WDT Append Waveforms CXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
Number of Waveform Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
WDT Number of Waveform Samples DBL VI . . . . . . . . . . . . . . . . . 914

© National Instruments 15
LabVIEW Programming Reference Manual

WDT Number of Waveform Samples CDB VI . . . . . . . . . . . . . . . . . 915


WDT Number of Waveform Samples EXT VI . . . . . . . . . . . . . . . . . 916
WDT Number of Waveform Samples I16 VI . . . . . . . . . . . . . . . . . . 917
WDT Number of Waveform Samples I32 VI . . . . . . . . . . . . . . . . . . 918
WDT Number of Waveform Samples I8 VI . . . . . . . . . . . . . . . . . . . 918
WDT Number of Waveform Samples SGL VI . . . . . . . . . . . . . . . . . 919
Waveform Min Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Waveform Scalar Limit Comparison. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
Search Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Waveform to XY Pairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
WDT Waveform to XY Pairs DBL VI . . . . . . . . . . . . . . . . . . . . . . . . . . 925
WDT Waveform to XY Pairs SGL VI . . . . . . . . . . . . . . . . . . . . . . . . . . 926
WDT Waveform to XY Pairs I64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
WDT Waveform to XY Pairs I32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
WDT Waveform to XY Pairs I16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
WDT Waveform to XY Pairs I8 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
WDT Waveform to XY Pairs U64 VI . . . . . . . . . . . . . . . . . . . . . . . . . . 933
WDT Waveform to XY Pairs U32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . 934
WDT Waveform to XY Pairs U16 VI . . . . . . . . . . . . . . . . . . . . . . . . . . 935
WDT Waveform to XY Pairs U8 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
WDT Waveform to XY Pairs CDB VI. . . . . . . . . . . . . . . . . . . . . . . . . . 938
WDT Waveform to XY Pairs CSG VI . . . . . . . . . . . . . . . . . . . . . . . . . . 939
WDT Waveform to XY Pairs EXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . 940
WDT Waveform to XY Pairs CXT VI . . . . . . . . . . . . . . . . . . . . . . . . . . 941
Waveform Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Waveform Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Basic Function Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Tones and Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
Formula Waveform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Sine Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
Square Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Triangle Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Sawtooth Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Basic Multitone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Basic Multitone with Amplitudes . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Multitone Generator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967

16 ni.com
LabVIEW Programming Reference Manual

Uniform White Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . 969


Gaussian White Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Periodic Random Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . 972
Inverse f Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
Gamma Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
Poisson Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Binomial Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Bernoulli Noise Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
MLS Sequence Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Simulate Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
Simulate Arbitrary Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
Waveform Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
Basic Averaged DC-RMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001
Basic Averaged DC-RMS for 1 Chan VI . . . . . . . . . . . . . . . . 1002
Basic Averaged DC-RMS for N Chan VI . . . . . . . . . . . . . . . . 1004
Averaged DC-RMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
Averaged DC-RMS for 1 Chan VI . . . . . . . . . . . . . . . . . . . . . . 1007
Averaged DC-RMS for N Chan VI . . . . . . . . . . . . . . . . . . . . . 1011
Cycle Average and RMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
Cycle Average and RMS 1 chan VI . . . . . . . . . . . . . . . . . . . . 1015
Cycle Average and RMS N chan VI . . . . . . . . . . . . . . . . . . . . 1020
Waveform Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025
Limit Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
Limit Testing Time VI . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
Limit Testing Frequency VI . . . . . . . . . . . . . . . . . . . . . 1031
Limit Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
Create Continuous Mask VI . . . . . . . . . . . . . . . . . . . . . 1037
Create Segmented Mask VI . . . . . . . . . . . . . . . . . . . . . 1039
Limit Specification By Formula . . . . . . . . . . . . . . . . . . . . . . 1041
Create Continuous Mask using Formula VI . . . . . . . 1042
Create Segmented Mask using Formula VI . . . . . . . 1044
Waveform Peak Detection . . . . . . . . . . . . . . . . . . . . . . . . . . 1046
Waveform Peak Detection for 1 Chan VI . . . . . . . . . 1046
Waveform Peak Detection for N Chan VI . . . . . . . . . 1049

© National Instruments 17
LabVIEW Programming Reference Manual

Basic Level Trigger Detection . . . . . . . . . . . . . . . . . . . . . . . . 1052


Trigger Detection for 1 Channel VI . . . . . . . . . . . . . . 1054
Trigger Detection for N Channel VI . . . . . . . . . . . . . . 1057
Mask and Limit Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
Trigger and Gate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
Transition Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071
Transition Measurements 1 chan VI . . . . . . . . . . . . . . . . . . 1075
Transition Measurements N chan VI . . . . . . . . . . . . . . . . . . 1083
Pulse Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
Pulse Measurements 1 chan VI . . . . . . . . . . . . . . . . . . . . . . 1093
Pulse Measurements N chan VI . . . . . . . . . . . . . . . . . . . . . . 1098
Reference and State Levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1103
Amplitude and Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1104
Amplitude and Levels 1 chan VI. . . . . . . . . . . . . . . . . . . . . . 1105
Amplitude and Levels N chan VI . . . . . . . . . . . . . . . . . . . . . 1107
Extract Single Tone Information . . . . . . . . . . . . . . . . . . . . . . . . . . 1109
Extract Single Tone Information 1 Chan VI . . . . . . . . . . . . 1111
Extract Single Tone Information 1 Chan (CDB) VI . . . . . . 1114
Extract Single Tone Information N Chan VI . . . . . . . . . . . . 1118
Extract Single Tone Information N Chan (CDB) VI . . . . . . 1122
Extract Multiple Tone Information . . . . . . . . . . . . . . . . . . . . . . . . 1126
Extract Multiple Tone Information 1 Chan VI . . . . . . . . . . 1128
Extract Multiple Tone Information 1 Chan (CDB) VI. . . . . 1131
Extract Multiple Tone Information N Chan VI . . . . . . . . . . 1135
Extract Multiple Tone Information N Chan - N Specs VI . . . . . .
1139
Extract Multiple Tone Information N Chan (CDB) VI . . . . 1143
Extract Multiple Tone Information N Chan - N Specs (CDB)
VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
Harmonic Distortion Analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1151
Harmonic Distortion Analyzer 1 Chan VI . . . . . . . . . . . . . . 1152
Harmonic Distortion Analyzer N Chan VI . . . . . . . . . . . . . . 1155
SINAD Analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
SINAD Analyzer 1 Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1160

18 ni.com
LabVIEW Programming Reference Manual

SINAD Analyzer N Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163


FFT Power Spectrum and PSD . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167
FFT Power Spectrum and PSD for 1 Chan VI . . . . . . . . . . . 1168
FFT Power Spectrum and PSD for N Chan VI . . . . . . . . . . 1172
FFT Power Spectrum and PSD for 1 Chan (CDB) VI . . . . . 1177
FFT Power Spectrum and PSD for N Chan (CDB) VI . . . . . 1181
FFT Spectrum (Mag-Phase) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186
FFT Spectrum (Mag-Phase) for 1 Chan VI . . . . . . . . . . . . . 1187
FFT Spectrum (Mag-Phase) for N Chan VI . . . . . . . . . . . . . 1192
FFT Spectrum (Mag-Phase) for 1 Chan (CDB) VI. . . . . . . . 1198
FFT Spectrum (Mag-Phase) for N Chan (CDB) VI . . . . . . . 1203
FFT Spectrum (Real-Im) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208
FFT Spectrum (Real-Im) for 1 Chan VI . . . . . . . . . . . . . . . . 1209
FFT Spectrum (Real-Im) for N Chan VI . . . . . . . . . . . . . . . . 1214
FFT Spectrum (Real-Im) for 1 Chan (CDB) VI . . . . . . . . . . . 1219
FFT Spectrum (Real-Im) for N Chan (CDB) VI . . . . . . . . . . 1224
Frequency Response Function (Mag-Phase) . . . . . . . . . . . . . . . 1228
Frequency Response Function (Mag-Phase) 1-1 VI . . . . . 1229
Frequency Response Function (Mag-Phase) 1-N VI . . . . . 1234
Frequency Response Function (Mag-Phase) N-1 VI . . . . . 1240
Frequency Response Function (Mag-Phase) N-M VI . . . . 1245
Frequency Response Function (Real-Im) . . . . . . . . . . . . . . . . . . 1251
Frequency Response Function (Real-Im) 1-1 VI . . . . . . . . 1252
Frequency Response Function (Real-Im) 1-N VI . . . . . . . . 1257
Frequency Response Function (Real-Im) N-1 VI . . . . . . . . 1262
Frequency Response Function (Real-Im) N-M VI . . . . . . . 1267
Cross Spectrum (Mag-Phase) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1272
Cross Spectrum (Real-Im) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1277
Spectral Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1280
.................................................. 1286
Dual Channel Spectral Measurement . . . . . . . . . . . . . . . . . . . . . 1288
.................................................. 1294
Distortion Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296
.................................................. 1299
Tone Measurements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
.................................................. 1303

© National Instruments 19
LabVIEW Programming Reference Manual

Timing and Transition Measurements . . . . . . . . . . . . . . . . . . . . . 1304


.................................................. 1307
Amplitude and Level Measurements . . . . . . . . . . . . . . . . . . . . . . 1308
.................................................. 1312
Digital Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313
Get Digital Waveform Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
Get Digital Data Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
Build Digital Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317
Build Digital Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
Set Waveform Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
Get Waveform Attribute Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1323
Digital Pattern Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
Digital Pattern Generator (Ramp) VI . . . . . . . . . . . . . . . . . . . . . . . 1327
Digital Pattern Generator (Marching Values) VI . . . . . . . . . . . . . 1328
Digital Pattern Generator (Single Value) VI . . . . . . . . . . . . . . . . . 1329
Digital Pattern Generator (Random) VI . . . . . . . . . . . . . . . . . . . . 1331
Digital Pattern Generator (Toggle) VI . . . . . . . . . . . . . . . . . . . . . . 1332
Digital Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
DWDT Digital Size VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
DTbl Digital Size VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1334
Digital Signal Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
DWDT Digital Signal Subset VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1336
DTbl Digital Signal Subset VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
Replace Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
DWDT Replace Subset VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1339
DTbl Replace Subset VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1341
Uncompress Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1342
DWDT Uncompress Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1342
DTbl Uncompress Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
Compress Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1344
DWDT Compress Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1344
DTbl Compress Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
Digital Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346
DWDT Digital To Digital Comparison VI . . . . . . . . . . . . . . . . . . . . 1347
DTbl Digital To Digital Comparison VI . . . . . . . . . . . . . . . . . . . . . 1349
DWDT Digital Comparison VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350

20 ni.com
LabVIEW Programming Reference Manual

DTbl Digital Comparison VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1352


Search for Digital Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1353
DWDT Search for Digital Pattern VI . . . . . . . . . . . . . . . . . . . . . . . . 1353
DTbl Search for Digital Pattern VI . . . . . . . . . . . . . . . . . . . . . . . . . 1355
Append Digital Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1357
DWDT Append Digital Signals VI . . . . . . . . . . . . . . . . . . . . . . . . . . 1358
DTbl Append Digital Signals VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
Append Digital Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1362
DWDT Append Digital Samples VI . . . . . . . . . . . . . . . . . . . . . . . . . 1362
DTbl Append Digital Samples VI . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
Invert Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
DWDT Invert Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366
DTbl Invert Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
Group Digital Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
Digital Ring Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1370
Empty Digital Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
Empty Digital Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1372
Digital Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1372
Boolean Array to Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
DWDT Boolean Array to Digital VI . . . . . . . . . . . . . . . . . . . . 1374
DTbl Boolean Array to Digital VI. . . . . . . . . . . . . . . . . . . . . . 1375
Binary to Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377
DWDT Binary U32 to Digital VI . . . . . . . . . . . . . . . . . . . . . . . 1377
DTbl Binary U32 to Digital VI . . . . . . . . . . . . . . . . . . . . . . . . 1378
DWDT Binary U16 to Digital VI . . . . . . . . . . . . . . . . . . . . . . . 1379
DTbl Binary U16 to Digital VI . . . . . . . . . . . . . . . . . . . . . . . . 1380
DWDT Binary U8 to Digital VI . . . . . . . . . . . . . . . . . . . . . . . . 1381
DTbl Binary U8 to Digital VI . . . . . . . . . . . . . . . . . . . . . . . . . 1382
Spreadsheet String to Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
DWDT Spreadsheet String to Digital VI. . . . . . . . . . . . . . . . 1383
DTbl Spreadsheet String to Digital VI . . . . . . . . . . . . . . . . . 1385
Digital to Boolean Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386
DWDT Digital to Boolean Array VI . . . . . . . . . . . . . . . . . . . . 1387
DTbl Digital to Boolean Array VI. . . . . . . . . . . . . . . . . . . . . . 1388
Digital to Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389
DWDT Digital to Binary U32 VI . . . . . . . . . . . . . . . . . . . . . . . 1390

© National Instruments 21
LabVIEW Programming Reference Manual

DTbl Digital to Binary U32 VI . . . . . . . . . . . . . . . . . . . . . . . . 1391


DWDT Digital to Binary U16 VI . . . . . . . . . . . . . . . . . . . . . . . 1391
DTbl Digital to Binary U16 VI . . . . . . . . . . . . . . . . . . . . . . . . 1392
DWDT Digital to Binary U8 VI . . . . . . . . . . . . . . . . . . . . . . . . 1393
DTbl Digital to Binary U8 VI . . . . . . . . . . . . . . . . . . . . . . . . . 1393
Waveform File I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394
Write Waveforms to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
Write Waveform to File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
Write Waveforms to File (1D) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1397
Write Waveforms to File (2D) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398
Write Waveform to File (Digital) VI . . . . . . . . . . . . . . . . . . . . . . . . 1399
Read Waveforms from File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
Read Waveform from File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
Read Waveform from File (Digital) VI . . . . . . . . . . . . . . . . . . . . . . 1402
Export Waveforms to Spreadsheet File . . . . . . . . . . . . . . . . . . . . . . . . . 1403
Export Waveforms To Spreadsheet File (1D) VI . . . . . . . . . . . . . 1403
Export Waveforms To Spreadsheet File (2D) VI . . . . . . . . . . . . . 1405
Export Waveform To Spreadsheet File VI. . . . . . . . . . . . . . . . . . . 1407
Export Waveforms To Spreadsheet File (Digital) VI . . . . . . . . . . 1409
Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1411
Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1412
Build Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1413
Insert Into Map Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1414
Remove From Map Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415
Look In Map Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416
Read Map Max & Min Keys Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417
Map Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1418
Collection Size Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1418
Empty Collection? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
Convert Map To Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
In Place Map Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1420
Registration Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1420
Registration Map:Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1421
Registration Map:Confirm Registration . . . . . . . . . . . . . . . . . . . . 1422
Registration Map:Unregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1422
Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424

22 ni.com
LabVIEW Programming Reference Manual

Build Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425


Insert Into Set Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
Remove From Set Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
Element of Set? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
Read Set Max & Min Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
Set Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
Collection Size Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
Empty Collection? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
Convert Set To Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430
Set Union . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431
Set Intersection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
Set Cartesian Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1433
Set Difference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1434
Set Symmetric Difference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435
File I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
Write Delimited Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1439
Write Delimited Spreadsheet (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 1440
Write Delimited Spreadsheet (I64) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
Write Delimited Spreadsheet (string) VI . . . . . . . . . . . . . . . . . . . . . . . . 1444
Read Delimited Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
Read Delimited Spreadsheet (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
Read Delimited Spreadsheet (I64) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
Read Delimited Spreadsheet (string) VI. . . . . . . . . . . . . . . . . . . . . . . . . 1451
Write To Measurement File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1454
............................................................ 1461
Read From Measurement File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1463
............................................................ 1468
Open/Create/Replace File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470
Close File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1472
Format Into File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1473
Scan From File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
Write to Text File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1480
Read from Text File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1482
Write to Binary File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1484
Read from Binary File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1487
Build Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1490

© National Instruments 23
LabVIEW Programming Reference Manual

Strip Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491


File Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491
Path Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1492
Current VI's Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1493
Get System Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1493
Empty Path Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1495
Not A Path Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1495
Not a Refnum Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496
Default Directory Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496
Default Data Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
VI Library Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
Application Directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
Temporary Directory Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
Configuration File VIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1499
Open Config Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1501
Read Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1502
Read Key (Boolean) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1502
Read Key (Double) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1504
Read Key (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
Read Key (Path) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1507
Read Key (String) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1508
Read Key (U32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1510
Write Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1511
Write Key (Boolean) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1512
Write Key (Double) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1514
Write Key (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516
Write Key (Path) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
Write Key (String) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1519
Write Key (U32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1520
Remove Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522
Remove Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1523
Close Config Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1524
Get Key Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1525
Get Section Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1526
Not A Config Data Refnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1527
TDM Streaming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1527

24 ni.com
LabVIEW Programming Reference Manual

TDMS Open Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1530


TDMS Write Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1533
TDMS Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537
TDMS Close Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1540
TDMS List Contents Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1542
TDMS Set Properties Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1543
TDMS Get Properties Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
TDMS Flush Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
TDMS File Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
TDMS Defragment Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
Advanced TDMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1559
TDMS Advanced Open Function . . . . . . . . . . . . . . . . . . . . . . . . . . 1561
TDMS Advanced Close Function . . . . . . . . . . . . . . . . . . . . . . . . . . 1564
TDMS Set Channel Information Function . . . . . . . . . . . . . . . . . . 1565
TDMS Create Scaling Information . . . . . . . . . . . . . . . . . . . . . . . . . 1570
TDMS Create Scaling Information (Linear) VI . . . . . . . . . . 1571
TDMS Create Scaling Information (Polynomial) VI . . . . . 1573
TDMS Create Scaling Information (Thermocouple) VI . . 1576
TDMS Create Scaling Information (RTD) VI . . . . . . . . . . . . 1578
TDMS Create Scaling Information (Table) VI . . . . . . . . . . . 1581
TDMS Create Scaling Information (Strain) VI . . . . . . . . . . 1584
TDMS Create Scaling Information (Thermistor) VI . . . . . 1587
TDMS Create Scaling Information (Reciprocal) VI . . . . . . 1590
TDMS Delete Data Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1592
TDMS Set Next Write Position Function . . . . . . . . . . . . . . . . . . . . 1595
TDMS Set Next Read Position Function . . . . . . . . . . . . . . . . . . . . 1597
TDMS Reserve File Size Function . . . . . . . . . . . . . . . . . . . . . . . . . 1598
TDMS Convert Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1601
TDMS Advanced Synchronous I/O . . . . . . . . . . . . . . . . . . . . . . . . 1603
TDMS Advanced Synchronous Write Function . . . . . . . . . 1603
TDMS Advanced Synchronous Read Function . . . . . . . . . 1604
TDMS Advanced Asynchronous I/O . . . . . . . . . . . . . . . . . . . . . . . 1606
TDMS Configure Asynchronous Writes Function . . . . . . . 1608
TDMS Advanced Asynchronous Write Function . . . . . . . . 1610
TDMS Get Asynchronous Write Status Function . . . . . . . 1612
TDMS Generate Random Data . . . . . . . . . . . . . . . . . . . . . . . 1613

© National Instruments 25
LabVIEW Programming Reference Manual

TDMS Generate Random Data (U8) VI . . . . . . . . . . . 1614


TDMS Generate Random Data (I8) VI . . . . . . . . . . . . 1615
TDMS Generate Random Data (U16) VI . . . . . . . . . . 1615
TDMS Generate Random Data (I16) VI . . . . . . . . . . . 1616
TDMS Generate Random Data (U32) VI . . . . . . . . . . 1617
TDMS Generate Random Data (I32) VI . . . . . . . . . . . 1618
TDMS Generate Random Data (U64) VI . . . . . . . . . . 1619
TDMS Generate Random Data (I64) VI . . . . . . . . . . . 1620
TDMS Generate Random Data (SGL) VI . . . . . . . . . . 1621
TDMS Generate Random Data (DBL) VI . . . . . . . . . . 1621
TDMS Generate Random Data (CSG) VI . . . . . . . . . . 1622
TDMS Generate Random Data (CDB) VI . . . . . . . . . . 1623
TDMS Configure Asynchronous Reads Function . . . . . . . 1624
TDMS Start Asynchronous Reads Function . . . . . . . . . . . . 1626
TDMS Stop Asynchronous Reads Function . . . . . . . . . . . . 1627
TDMS Get Asynchronous Read Status Function. . . . . . . . 1629
TDMS Advanced Asynchronous Read Function . . . . . . . . 1630
TDMS Advanced Data Reference I/O . . . . . . . . . . . . . . . . . . . . . . . 1632
TDMS Configure Asynchronous Writes (Data Ref) Function . .
1634
TDMS Advanced Asynchronous Write (Data Ref) Function . . .
1635
TDMS Get Asynchronous Write Status (Data Ref) Function . . .
1637
TDMS Configure Asynchronous Reads (Data Ref) Function . .
1638
TDMS Advanced Asynchronous Read (Data Ref) Function . . .
1639
TDMS Get Asynchronous Read Status (Data Ref) Function . . .
1641
TDMS In Memory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1642
TDMS In Memory Open Function . . . . . . . . . . . . . . . . . . . . 1643
TDMS In Memory Read Bytes Function . . . . . . . . . . . . . . . 1644
TDMS In Memory Close Function . . . . . . . . . . . . . . . . . . . . 1646
Storage/DataPlugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1647
Open Data Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1649

26 ni.com
LabVIEW Programming Reference Manual

Write Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1652


Read Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1656
Close Data Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1659
Set Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1660
Get Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1664
Delete Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1669
Delete Channel VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1670
Delete Channel Group VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1670
Data File Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1671
Convert to TDM or TDMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1672
Manage DataPlugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1674
List DataPlugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1675
Export DataPlugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1677
Register DataPlugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1678
Register DataPlugin by URI VI. . . . . . . . . . . . . . . . . . . . . . . . 1679
Install DataPlugin by Name VI . . . . . . . . . . . . . . . . . . . . . . . 1681
Unregister DataPlugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683
Advanced Storage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1684
Get Object Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685
Get Property Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1686
Set Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687
Set Property (String) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1688
Set Property (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689
Set Property (SGL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1690
Set Property (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691
Set Property (I16) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692
Set Property (U8) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1693
Set Property (Enum) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694
Set Property (Time Stamp) VI. . . . . . . . . . . . . . . . . . . . . . . . 1695
Set Property (Storage Refnum) VI . . . . . . . . . . . . . . . . . . . . 1696
Set Property (Storage Refnums) VI . . . . . . . . . . . . . . . . . . . 1697
Get Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1698
Get Property (String) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1699
Get Property (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1700
Get Property (SGL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1701
Get Property (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1702

© National Instruments 27
LabVIEW Programming Reference Manual

Get Property (I16) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1703


Get Property (U8) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1704
Get Property (Enum) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1705
Get Property (Time Stamp) VI . . . . . . . . . . . . . . . . . . . . . . . 1706
Get Property (Storage Refnum) VI . . . . . . . . . . . . . . . . . . . . 1707
Get Property (Storage Refnums) VI . . . . . . . . . . . . . . . . . . . 1708
Merge Storage Refnums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1709
Merge Storage Refnums (Channel) VI . . . . . . . . . . . . . . . . . 1709
Merge Storage Refnums (Channel group) VI . . . . . . . . . . . 1710
Create Query Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1711
Create Query Expression (String) VI . . . . . . . . . . . . . . . . . . 1712
Create Query Expression (I32) VI . . . . . . . . . . . . . . . . . . . . . 1713
Create Query Expression (DBL) VI . . . . . . . . . . . . . . . . . . . . 1714
Create Query Expression (Time Stamp) VI. . . . . . . . . . . . . 1715
Merge Query Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1717
Execute Query Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1717
Refnum to ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1718
ID to Refnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1719
GetObjectFromID_Storage VI . . . . . . . . . . . . . . . . . . . . . . . . 1720
GetObjectFromID_Object VI . . . . . . . . . . . . . . . . . . . . . . . . . 1720
Zip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1721
New Zip File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1722
Add File to Zip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1723
Close Zip File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1724
Unzip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1725
XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1726
LabVIEW Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1727
Flatten To XML Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1728
Unflatten From XML Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1729
Write to XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1730
Write to XML File(string) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 1731
Write to XML File(array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1732
Read From XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1734
Read From XML File(array) VI . . . . . . . . . . . . . . . . . . . . . . . . 1734
Read From XML File(string) VI . . . . . . . . . . . . . . . . . . . . . . . 1735
Escape XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737

28 ni.com
LabVIEW Programming Reference Manual

Unescape XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1737


XML Parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1738
New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1740
Property Node (XML) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
Invoke Node (XML) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1742
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1742
Close Reference(NNMap) VI . . . . . . . . . . . . . . . . . . . . . . . . . 1743
Close Reference(NdList) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 1743
Close Reference(Impl) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1744
Close Reference(Node) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1745
Get First Matched Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1746
Get All Matched Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1747
Get Next Non-Text Sibling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1748
Get First Non-Text Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1749
Get Node Text Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1750
Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1750
Load XML File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1751
Load XML String VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1753
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1756
Waveform File I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1757
Advanced File Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1758
Get File Position Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1761
Get File Size Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1762
Get Permissions Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1763
Get Type and Creator Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1764
Preallocated Read from Binary File Function. . . . . . . . . . . . . . . . . . . . 1766
File Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1770
....................................................... 1773
Set File Position Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1774
Set File Size Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1775
Set Permissions Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1776
Set Type and Creator Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1777
Show in File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1778
Is Name Multiplatform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1779
Create File with Incrementing Suffix . . . . . . . . . . . . . . . . . . . . . . . . . . . 1780
Move Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1782

© National Instruments 29
LabVIEW Programming Reference Manual

Copy Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1784


Delete Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1786
Flush File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1788
Deny Access Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1789
File/Directory Info Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
Get Volume Info Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1791
Create Folder Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1793
List Folder Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1794
Check if File or Folder Exists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1796
Recursive File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1797
Path To String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1798
String To Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1799
Path to Array of Strings Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
Array of Strings to Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1800
Refnum to Path Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1802
Path Type Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1802
Compare Two Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1803
Get File Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1804
File Checksum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1805
SHA-256 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1806
SHA-224 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1806
SHA-512 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1807
SHA-384 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1808
SHA-512-256 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1809
SHA-512-224 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 1809
SHA3-224 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1810
SHA3-256 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1811
SHA3-384 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1811
SHA3-512 File Checksum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1812
Generate Temporary File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1813
Datalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1814
Open/Create/Replace Datalog Function . . . . . . . . . . . . . . . . . . . 1815
Close File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1817
Read Datalog Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1818
Set Datalog Position Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1819
Set Number of Records Function . . . . . . . . . . . . . . . . . . . . . . . . . 1820

30 ni.com
LabVIEW Programming Reference Manual

Write Datalog Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1821


Get Datalog Position Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1822
Get Number of Records Function . . . . . . . . . . . . . . . . . . . . . . . . . 1823
Packed Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
Get Exported File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1824
Get Exported File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1825
Packed Library Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1826
Create Directory Recursive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1826
Create File and Containing Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1828
Contiguous and Noncontiguous Array Slices . . . . . . . . . . . . . . . . . . . . . . . . . 1829
Setting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1831
UNC Filename Support of File I/O VIs on Windows . . . . . . . . . . . . . . . . . . . . 1832
Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1832
Tick Count (ms) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1834
High Resolution Relative Seconds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1835
Wait (ms) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1835
Wait Until Next ms Multiple Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1837
Stall Data Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1838
Get Date/Time String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1838
Get Date/Time In Seconds Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1840
Date/Time To Seconds Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1840
Seconds To Date/Time Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1842
To Time Stamp Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1844
Time Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1845
............................................................ 1845
Tick Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1845
............................................................ 1846
Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1847
............................................................ 1848
Elapsed Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1848
............................................................ 1851
High Resolution Polling Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1851
Format Date/Time String Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1852
Time Stamp Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1853
Dialog & User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1854
One Button Dialog Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1857

© National Instruments 31
LabVIEW Programming Reference Manual

Two Button Dialog Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1857


Three Button Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1858
Simple Error Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1862
General Error Handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1863
Clear Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1867
Error Ring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1867
Merge Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1869
Error Cluster From Error Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1870
Find First Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1871
Error Cluster Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1872
Multiple Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1872
Error Cluster to Array of Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1873
Convert to Legacy Error Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1874
Convert to Encoded Error Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1874
Write Error Cluster Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1875
Remove Error Cluster Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1876
List Error Cluster Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1876
Read Error Cluster Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1877
Prompt User for Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1878
............................................................ 1879
Display Message to User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1880
............................................................ 1881
Write to System Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1882
Wait For Front Panel Activity Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1883
Generate Front Panel Activity Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1885
Color Box Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1886
Listbox Symbol Ring Constant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1886
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1886
Register For Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1888
Unregister For Events Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1890
Flush Event Queue Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1891
Create User Event Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1894
Generate User Event Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1896
Destroy User Event Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1897
Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1898
Current VI's Menubar Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1899

32 ni.com
LabVIEW Programming Reference Manual

Get Menu Selection Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1899


Enable Menu Tracking Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1901
Insert Menu Items Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1902
Delete Menu Items Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1904
Set Menu Item Info Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1905
Get Menu Item Info Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1907
Get Menu Short Cut Info Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1909
Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1911
Create Cursor From File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1912
Set Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1914
Set Cursor (Icon Pict) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1914
Set Cursor (Cursor ID) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1916
Destroy Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1918
Set Busy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1919
Unset Busy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1920
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1922
Control Help Window Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1922
Get Help Window Status Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1923
Control Online Help Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1924
Open URL in Default Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1926
Open URL in Default Browser (string) VI . . . . . . . . . . . . . . . . . . . 1926
Open URL in Default Browser (path) VI . . . . . . . . . . . . . . . . . . . . 1927
Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1928
Notifier Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1929
Obtain Notifier Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1930
Send Notification Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1932
Cancel Notification Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1933
Get Notifier Status Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1934
Release Notifier Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1935
Wait on Notification Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1937
Wait on Notification from Multiple Function . . . . . . . . . . . . . . . . . . . . 1939
Advanced Notifier Waiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1941
Wait on Notification with Notifier History Function . . . . . . . . . 1941
Wait on Notification from Multiple with Notifier History
Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1944
Queue Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1946

© National Instruments 33
LabVIEW Programming Reference Manual

Obtain Queue Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1947


Enqueue Element Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1950
Preview Queue Element Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1952
Get Queue Status Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1953
Release Queue Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1955
Lossy Enqueue Element Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1956
Enqueue Element At Opposite End Function . . . . . . . . . . . . . . . . . . . . 1958
Dequeue Element Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1959
Flush Queue Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1961
Semaphore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1962
Obtain Semaphore Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1963
Acquire Semaphore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1964
Release Semaphore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1966
Release Semaphore Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1967
Get Semaphore Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1968
Not A Semaphore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1969
Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1970
Create Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1971
Wait at Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1972
Resize Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1973
Destroy Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1974
Get Rendezvous Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1975
Not A Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1976
Occurrences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1977
Generate Occurrence Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1978
Wait on Occurrence Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
Set Occurrence Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1980
First Call? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1981
Synchronize Data Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1982
Graphics & Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1983
3D Graph Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1984
3D Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1985
3D Parametric Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1987
3D Curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1988
Basic Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1989
Axes Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1991

34 ni.com
LabVIEW Programming Reference Manual

Grid Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1992


Projection Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1993
Convert OLE Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
Set Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1995
Picture Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1996
Polar Plot with Point Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1998
Smith Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2003
Smith Multi Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2008
Normalize Smith Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2014
Plot XY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2015
Plot Multi-XY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2022
Plot Waveform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2029
Radar Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2036
Draw Legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2042
Calc Scale Specs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2045
Draw Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2049
Map Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2053
Map Value to Pixel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2054
Map Pixel to Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2055
Picture Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2056
Draw Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2058
Move Pen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2060
Draw Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2061
Draw Multiple Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2064
Draw Rectangle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2065
Draw Grayed Out Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2067
Draw Round Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2069
Draw Oval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2071
Draw Arc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2073
Draw Text at Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2076
Get Text Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2080
Draw Text in Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2084
Draw Circle by Radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2087
Hilite Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2090
Draw Unflattened Pixmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2091
Draw True-Color Pixmap VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2091

© National Instruments 35
LabVIEW Programming Reference Manual

Draw 1-Bit Pixmap VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2092


Draw 4-Bit Pixmap VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2094
Draw 8-Bit Pixmap VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2095
Draw Flattened Pixmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2097
Create Mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2100
Picture to Pixmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2105
Get Image Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2109
Empty Picture VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2115
Color Box Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2115
Color to RGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2116
RGB to Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2117
Graphics Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2117
Write JPEG File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2118
Write PNG File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2122
Write BMP File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2125
Read JPEG File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2128
Read PNG File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2131
Read BMP File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2134
Flatten Pixmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2137
Unflatten Pixmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2141
Beep (Windows) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2145
Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2146
Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2147
Play Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2149
.................................................. 2150
Sound Output Configure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2151
Sound Output Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2153
Sound Output Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2154
Sound Output Write (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . 2155
Sound Output Write (DBL Single) VI . . . . . . . . . . . . . . . . . . 2157
Sound Output Write (SGL) VI . . . . . . . . . . . . . . . . . . . . . . . . 2158
Sound Output Write (U8) VI . . . . . . . . . . . . . . . . . . . . . . . . . 2160
Sound Output Write (I16) VI . . . . . . . . . . . . . . . . . . . . . . . . . 2162
Sound Output Write (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . 2163
Sound Output Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2165
Sound Output Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2166

36 ni.com
LabVIEW Programming Reference Manual

Sound Output Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2167


Sound Output Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2168
Sound Output Set Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2169
Sound Output Set Volume (Single) VI . . . . . . . . . . . . . . . . 2170
Sound Output Set Volume (Array) VI . . . . . . . . . . . . . . . . . 2172
Play Sound File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2173
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2174
Acquire Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2176
.................................................. 2177
Sound Input Configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2178
Sound Input Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2180
Sound Input Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2181
Sound Input Read (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 2182
Sound Input Read (SGL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 2183
Sound Input Read (U8) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 2185
Sound Input Read (I16) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 2187
Sound Input Read (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 2188
Sound Input Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2190
Sound Input Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2191
Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2192
Sound File Read Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2193
Sound File Write Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2195
Sound File Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2196
Sound File Read Open VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2197
Sound File Write Open VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 2198
Sound File Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2199
Sound File Info (path) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2200
Sound File Info (refnum) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 2202
Sound File Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2203
Sound File Read (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2204
Sound File Read (SGL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2206
Sound File Read (U8) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2208
Sound File Read (I16) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2210
Sound File Read (I32) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2212
Sound File Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2214
Sound File Write (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 2215

© National Instruments 37
LabVIEW Programming Reference Manual

Sound File Write (DBL Single) VI . . . . . . . . . . . . . . . . . . . . . 2216


Sound File Write (SGL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 2217
Sound File Write (U8) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2218
Sound File Write (I16) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2220
Sound File Write (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2221
Sound File Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2222
Math Plot Helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223
2D Compass Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2224
Plot Helper (Complex) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2225
2D Error Bar Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2226
Plot Helper (Percentage) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2227
Plot Helper (Fixed) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2228
2D Feather Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2230
Plot Helper (Complex) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2232
3D Bar Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2233
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2234
3D Comet Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2235
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2236
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2238
Plot Helper (Matrices) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
3D Contour Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2241
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2243
3D Mesh Plot Helper. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2244
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2245
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2247
3D Pie Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2248
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2249
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2250
3D Quiver Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2251
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2252
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2253
3D Ribbon Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2255

38 ni.com
LabVIEW Programming Reference Manual

Plot Helper (Standard) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2256


Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2257
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2259
3D Scatter Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2260
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2261
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2262
Plot Helper (Matrices) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2264
3D Stem Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2265
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2266
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2267
Plot Helper (Matrices) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2269
3D Surface Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2270
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2271
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2273
3D Waterfall Plot Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2274
Plot Helper (Vector) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2275
Plot Helper (Matrix) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2276
3D Line Plot Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2278
3D Surface Plot Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2279
3D Parametric Plot Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2280
XY Plot Matrix Helper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2281
3D Picture Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2283
Geometries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2283
Create Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2284
Create Sphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2286
Create Cone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2288
Create Cylinder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2289
Create Height Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2291
Create Mesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2292
Create Mesh with Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2293
Create 3D Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2297
Create Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
Create Text with Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2300
Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2303
Create Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2304
Add Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2304

© National Instruments 39
LabVIEW Programming Reference Manual

Add Object (no reference) VI . . . . . . . . . . . . . . . . . . . . . . . . 2305


Add Object (reference) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 2305
Find Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2306
Set Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2307
Set Drawing Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2310
Set Blending . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2312
Transformations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2314
Rotate X-axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2316
Rotate Y-axis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2317
Rotate Z-axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2318
Get Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2319
Set Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2320
Rotate Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2321
Get Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2323
Set Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2324
Translate Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2325
Get Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2327
Set Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2328
Scale Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2329
Clear Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2330
File Loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
Load VRML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2331
Load ASE Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2332
Load STL Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2333
Helpers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2334
Color Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2335
Setup Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2336
Sensor Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2337
.................................................. 2340
Create Clip Plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2342
New Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2344
Texture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2345
Set Clip Plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2348
Set Clip Plane (no reference) VI . . . . . . . . . . . . . . . . . . . . . . 2348
Set Clip Plane (reference) VI . . . . . . . . . . . . . . . . . . . . . . . . . 2349
Set Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2350

40 ni.com
LabVIEW Programming Reference Manual

Set Light (no reference) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . 2350


Set Light (reference) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2352
Apply Texture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2353
Apply Texture (no reference) VI . . . . . . . . . . . . . . . . . . . . . . 2354
Apply Texture (reference) VI . . . . . . . . . . . . . . . . . . . . . . . . . 2357
Application Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2361
Open Application Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2364
Open VI Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2366
Static VI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2373
Close Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2375
Get Command Line Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2376
Property Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2377
Invoke Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2380
Call By Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2382
Start Asynchronous Call VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2384
Wait On Asynchronous Call VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2386
To More Specific Class Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2388
To More Generic Class Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2390
Class Specifier Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2391
VI Server Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2392
Call Chain Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2393
Get Drag Drop Data Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2393
Stop Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2395
Quit LabVIEW Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2396
Set Control Values by Index Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2396
Get Control Values by Index Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2398
Palette Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2399
Write Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2400
Read Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2405
Refresh Palettes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2410
CPU Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2410
CPU Information Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2411
Number of Cache Levels Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2412
Data Cache Size Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2412
Memory Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2413
New Data Value Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 2414

© National Instruments 41
LabVIEW Programming Reference Manual

Delete Data Value Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . 2415


Get Memory Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2416
Swap Values Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2417
Always Copy Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2418
Request Deallocation Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2418
VI Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2419
New VI Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2420
Open VI Object Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2423
New VI Object Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2425
New VI Object Offset From Referenced Object. . . . . . . . . . . . . . . . . . . 2427
Traverse for GObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2429
Get GObject Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2431
Get Class Hierarchy from Class Name . . . . . . . . . . . . . . . . . . . . . . . . . . 2432
Application Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2433
Build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2434
Build (path) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2434
Build (project reference) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2436
Deploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2437
Clean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2438
Get Build Specification Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2439
Get Build Specification Version (path) VI . . . . . . . . . . . . . . . . . . . 2440
Get Build Specification Version (project reference) VI . . . . . . . 2443
Set Build Specification Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2445
Set Build Specification Version (path) VI . . . . . . . . . . . . . . . . . . . 2446
Set Build Specification Version (project reference) VI . . . . . . . 2448
Report Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2450
Create Easy Text Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
Print VI Panel or Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2457
Print VI Panel or Documentation (path) VI . . . . . . . . . . . . . . . . . . . . . . 2458
Print VI Panel or Documentation (refnum) VI . . . . . . . . . . . . . . . . . . . . 2467
Print VI Panel or Documentation (string) VI . . . . . . . . . . . . . . . . . . . . . 2476
VI Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2485
Append Front Panel Image to Report. . . . . . . . . . . . . . . . . . . . . . . . . . . 2487
Append Front Panel Image to Report (path) VI . . . . . . . . . . . . . 2488
Append Front Panel Image to Report (refnum) VI . . . . . . . . . . . 2492
Append Front Panel Image to Report (string) VI . . . . . . . . . . . . 2495

42 ni.com
LabVIEW Programming Reference Manual

Append VI Block Diagram to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2499


Append VI Block Diagram to Report (path) VI . . . . . . . . . . . . . . 2500
Append VI Block Diagram to Report (refnum) VI . . . . . . . . . . . . 2503
Append VI Block Diagram to Report (string) VI . . . . . . . . . . . . . 2507
Append VI Description to Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2510
Append VI Description to Report (path) VI . . . . . . . . . . . . . . . . . 2511
Append VI Description to Report (refnum) VI . . . . . . . . . . . . . . . 2513
Append VI Description to Report (string) VI . . . . . . . . . . . . . . . . 2515
Append VI Icon to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2517
Append VI Icon to Report (path) VI . . . . . . . . . . . . . . . . . . . . . . . . 2518
Append VI Icon to Report (refnum) VI . . . . . . . . . . . . . . . . . . . . . 2521
Append VI Icon to Report (string) VI . . . . . . . . . . . . . . . . . . . . . . . 2524
Append VI Hierarchy to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2527
Append VI Hierarchy to Report (path) VI . . . . . . . . . . . . . . . . . . . 2527
Append VI Hierarchy to Report (refnum) VI. . . . . . . . . . . . . . . . . 2530
Append VI Hierarchy to Report (string) VI . . . . . . . . . . . . . . . . . . 2533
Append VI History to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2536
Append VI History to Report (path) VI . . . . . . . . . . . . . . . . . . . . . 2537
Append VI History to Report (refnum) VI . . . . . . . . . . . . . . . . . . . 2539
Append VI History to Report (string) VI . . . . . . . . . . . . . . . . . . . . 2541
Append VI List of Controls to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . 2543
Append VI List of Controls to Report (path) VI . . . . . . . . . . . . . . 2544
Append VI List of Controls to Report (refnum) VI. . . . . . . . . . . . 2547
Append VI List of Controls to Report (string) VI . . . . . . . . . . . . . 2551
Append VI List of SubVIs to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2554
Append VI List of SubVIs to Report (path) VI . . . . . . . . . . . . . . . . 2554
Append VI List of SubVIs to Report (refnum) VI . . . . . . . . . . . . . 2558
Append VI List of SubVIs to Report (string) VI . . . . . . . . . . . . . . . 2561
Create Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2564
Print Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2566
Save Report to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2567
Dispose Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2568
HTML Reports Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2569
Append Horizontal Line to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2570
Append Hypertext Link Anchor to Report . . . . . . . . . . . . . . . . . . . . . . . 2573
Append User Formatted HTML to Report . . . . . . . . . . . . . . . . . . . . . . . 2575

© National Instruments 43
LabVIEW Programming Reference Manual

Open HTML Report in Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2576


Open HTML Report in Browser (Refnum) VI . . . . . . . . . . . . . . . . 2577
Open HTML Report in Browser (Path) VI . . . . . . . . . . . . . . . . . . . 2578
Open HTML Report in Browser (String) VI . . . . . . . . . . . . . . . . . . 2579
Set Report Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2580
Append Report Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2584
Append Report Text (str wrap) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2584
Append Report Text (num wrap) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2587
Append Table to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2589
Append Text Table to Report (wrap) VI . . . . . . . . . . . . . . . . . . . . . . . . . 2590
Append Numeric Table to Report (wrap) VI . . . . . . . . . . . . . . . . . . . . . 2593
Append List to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2597
Report Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2599
Set Report Margins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2600
Set Report Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2601
New Report Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2602
New Report Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2604
Set Report Header Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2605
Set Report Footer Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2607
Append Front Panel Image to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2608
Append Control Image to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2609
Append Image to Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2613
Append Image to Report (path wrap) VI . . . . . . . . . . . . . . . . . . . . . . . . 2613
Append Image to Report (string wrap) VI . . . . . . . . . . . . . . . . . . . . . . . 2616
Advanced Report Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2619
Report Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2620
Get Report Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2621
Append File to Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2622
Clear Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2625
Clear Report Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2625
Query Available Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2626
Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2627
............................................................ 2630
Measurement I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2632
NI Scan Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2632
Synchronize to Scan Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2634

44 ni.com
LabVIEW Programming Reference Manual

Get Scan Engine Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2635


Set Scan Engine Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2635
Get Scan Engine Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2636
Set Scan Engine Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2637
Refresh Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2638
Forcing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2639
Enable Variable Forcing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2640
Disable Variable Forcing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2641
Clear Variable Forcing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2641
Force Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2642
Unforce Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2643
Faults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2644
Get Fault List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2645
Set Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2647
Clear Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2648
Clear All Faults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2649
Fault Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2650
Set Fault Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2650
Clear Fault Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2652
Get All Fault Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2653
Instrument I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2654
Instrument Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2655
VISA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2655
VISA Write Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2656
VISA Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2658
VISA Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2659
VISA Open Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2661
VISA Close Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2663
VISA Find Resource Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2664
VISA Set Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2668
VISA Property Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2669
Bus/Interface Specific . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2669
Serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2671
VISA Configure Serial Port . . . . . . . . . . . . . . . . . . . . . . . . . . 2672
VISA Configure Serial Port (Instr) VI . . . . . . . . . . . . . 2673
VISA Configure Serial Port (Serial Instr) VI . . . . . . . . 2676

© National Instruments 45
LabVIEW Programming Reference Manual

VISA Write Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2679


VISA Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2680
VISA Close Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2682
VISA Bytes at Serial Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2683
VISA Serial Break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2684
VISA Serial Break (Instr) VI . . . . . . . . . . . . . . . . . . . . . 2685
VISA Serial Break (Serial Instr) VI . . . . . . . . . . . . . . . . 2686
VISA Set I/O Buffer Size Function . . . . . . . . . . . . . . . . . . . . 2687
VISA Flush I/O Buffer Function . . . . . . . . . . . . . . . . . . . . . . . 2688
VISA USB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2689
VISA USB Control In Function . . . . . . . . . . . . . . . . . . . . . . . 2690
VISA USB Control Out Function . . . . . . . . . . . . . . . . . . . . . . 2692
VISA Get USB Interrupt Data . . . . . . . . . . . . . . . . . . . . . . . . . 2693
VISA Set I/O Buffer Size Function . . . . . . . . . . . . . . . . . . . . . . . . . 2694
VISA Flush I/O Buffer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2696
VISA GPIB Command Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 2697
VISA GPIB Control ATN Function . . . . . . . . . . . . . . . . . . . . . . . . . . 2698
VISA GPIB Pass Control Function . . . . . . . . . . . . . . . . . . . . . . . . . 2699
VISA GPIB Send IFC Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2700
VISA GPIB Control REN Function . . . . . . . . . . . . . . . . . . . . . . . . . . 2701
VISA VXI Cmd or Query Function . . . . . . . . . . . . . . . . . . . . . . . . . . 2702
VISA Assert Interrupt Signal Function . . . . . . . . . . . . . . . . . . . . . 2704
VISA Assert Utility Signal Function . . . . . . . . . . . . . . . . . . . . . . . . 2705
VISA Map Trigger Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2706
VISA Unmap Trigger Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2708
VISA Write From File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2710
VISA Read To File Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2711
Event Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2712
VISA Enable Event Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2713
VISA Wait on Event Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2715
VISA Disable Event Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2718
VISA Discard Events Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2719
Wait for RQS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2721
Select Event Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2723
VISA Lock Async . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2724
VISA Unlock Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2725

46 ni.com
LabVIEW Programming Reference Manual

Register Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2726


VISA In 8 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2728
VISA In 16 Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2729
VISA In 32 Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2731
VISA In 64 Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2733
VISA Out 8 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2735
VISA Out 16 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2736
VISA Out 32 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2738
VISA Out 64 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2740
VISA Move In 8 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2742
VISA Move In 16 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2744
VISA Move In 32 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2746
VISA Move In 64 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2748
VISA Move Out 8 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2750
VISA Move Out 16 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2752
VISA Move Out 32 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2754
VISA Move Out 64 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2756
VISA Memory Allocation Function. . . . . . . . . . . . . . . . . . . . . . . . . 2758
VISA Memory Allocation Ex Function . . . . . . . . . . . . . . . . . . . . . . 2759
VISA Memory Free Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2761
VISA Move Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2762
Low Level Register Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2764
VISA Map Address Function . . . . . . . . . . . . . . . . . . . . . . . . . 2765
VISA Unmap Address Function . . . . . . . . . . . . . . . . . . . . . . 2767
VISA Peek 8 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2768
VISA Peek 16 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2769
VISA Peek 32 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2770
VISA Peek 64 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2771
VISA Poke 8 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2772
VISA Poke 16 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2773
VISA Poke 32 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2775
VISA Poke 64 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2776
VISA Clear Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2777
VISA Read STB Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2778
VISA Assert Trigger Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2779
GPIB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2781

© National Instruments 47
LabVIEW Programming Reference Manual

GPIB Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2783


GPIB Write Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2786
Wait for GPIB RQS Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2789
GPIB Trigger Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2790
GPIB Clear Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2792
GPIB Serial Poll Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2793
GPIB Initialization Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2795
GPIB Status Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2796
GPIB Wait Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2798
GPIB Misc Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2801
GPIB 488.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2803
Send Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2805
Receive Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2807
Trigger Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2809
DevClear Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2811
ReadStatus Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2813
PPollConfig Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2814
PPollUnconfig Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2816
PassControl Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2818
SendList Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2819
FindRQS Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2821
TriggerList Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2823
DevClearList Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2824
AllSpoll Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2826
PPoll Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2828
EnableRemote Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2829
EnableLocal Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2831
FindLstn Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2832
TestSys Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2834
ResetSys Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2836
SendIFC Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2838
TestSRQ Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2839
WaitSRQ Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2841
SetRWLS Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2842
SendLLO Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2844
SendDataBytes Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2845

48 ni.com
LabVIEW Programming Reference Manual

SendSetup Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2847


SendCmds Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2849
RcvRespMsg Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2850
ReceiveSetup Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2852
SetTimeOut Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2854
MakeAddr Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2855
GPIB Device and Controller Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2856
Controller Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2856
Device Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2863
GPIB Function Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2865
GPIB Multiline Interface Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2865
Configuring Serial and Parallel Ports with VISA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2866
VISA Resource Name Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2867
VISA Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2871
Serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2874
Vision and Motion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2875
Mathematics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2875
Numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2877
Elementary & Special Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2881
Trigonometric Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2883
Sine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2884
Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2885
Tangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2885
Secant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2886
Cosecant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2887
Cotangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2888
Inverse Sine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2888
Inverse Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2889
Inverse Tangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2890
Inverse Secant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2891
Inverse Cosecant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2891
Inverse Cotangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2892
Sine & Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2893
Sinc Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2893
Inverse Tangent (2 Input) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2894
Exponential Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2895

© National Instruments 49
LabVIEW Programming Reference Manual

Exponential Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2896


Exponential (Arg) -1 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2897
Power Of 10 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2898
Power Of 2 Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2899
Power Of X Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2900
Y-th Root of X Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2901
Natural Logarithm Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2902
Natural Logarithm (Arg +1) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 2903
Logarithm Base 10 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2904
Logarithm Base 2 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2904
Logarithm Base X Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2905
Hyperbolic Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2906
Hyperbolic Sine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2907
Hyperbolic Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2908
Hyperbolic Tangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2908
Hyperbolic Secant Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2909
Hyperbolic Cosecant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2910
Hyperbolic Cotangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2910
Inverse Hyperbolic Sine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2911
Inverse Hyperbolic Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 2912
Inverse Hyperbolic Tangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . 2912
Inverse Hyperbolic Secant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 2913
Inverse Hyperbolic Cosecant Function . . . . . . . . . . . . . . . . . . . . . . . . . 2914
Inverse Hyperbolic Cotangent Function . . . . . . . . . . . . . . . . . . . . . . . . 2915
Gating Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2915
Spike Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2916
Square Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2917
Step Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2918
Discrete Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2919
Gcd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2920
Lcm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2921
Factorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2922
Prime Factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2923
Check Prime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2923
Permute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2924
Binomial Coefficient VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2924

50 ni.com
LabVIEW Programming Reference Manual

Continued Fraction VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2925


(Riemann) Zeta Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2926
Bessel Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2927
Bessel Function Jv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2928
Bessel Function Yv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2929
Hankel Function Hv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2930
Modified Bessel Function Iv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2931
Modified Bessel Function Kn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2932
Spherical Bessel Function jn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2933
Spherical Bessel Function yn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2934
Spherical Hankel Function hn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2935
Airy Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2936
Struve Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2937
Kelvin Functions be . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2938
Kelvin Functions ke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2939
Gamma Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2940
Factorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2941
(Incomplete) Gamma Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2941
Gamma Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2942
Incomplete Gamma Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . 2944
Stirling's Formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2945
(Incomplete) Beta Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2946
Beta Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2947
Incomplete Beta Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2948
Logarithm of Factorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2950
Logarithm of Complete Gamma Function . . . . . . . . . . . . . . . . . . . . . . 2950
Complementary Incomplete Gamma Function . . . . . . . . . . . . . . . . . . 2950
Psi (Digamma) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2951
Hypergeometric Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2952
Gauss Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2953
Kummer Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2954
Tricomi Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2955
Elliptic Integrals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2956
Elliptic Integral of the 1st kind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2956
Complete Elliptic Integral K VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2957
Incomplete Elliptic Integral F VI. . . . . . . . . . . . . . . . . . . . . . . . . . . 2958

© National Instruments 51
LabVIEW Programming Reference Manual

Elliptic Integral of the 2nd kind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2960


Complete Elliptic Integral E VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2961
Incomplete Elliptic Integral E VI . . . . . . . . . . . . . . . . . . . . . . . . . . 2962
Exponential Integrals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2963
Exponential Integral. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2964
Sine Integral. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2965
Cosine Integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2966
Dilogarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2967
Hyperbolic Sine Integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2968
Hyperbolic Cosine Integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2968
Error Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2969
Error Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2970
Error Function Complement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2970
Scaled Error Function Complement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2971
Inverse Error Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2972
Inverse Error Function Complement . . . . . . . . . . . . . . . . . . . . . . . . . . . 2972
Fresnel Integrals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2973
Dawson's Integral . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2973
Elliptic & Parabolic Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2974
Jacobian Elliptic Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2975
Parabolic Cylinder Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2976
Linear Algebra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2977
Create Special Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2982
Create Special Real Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2982
Create Special Complex Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2985
Create Real Matrix From Eigenvalues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2987
Solve Linear Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2988
Solve Linear Equations (single right hand) VI . . . . . . . . . . . . . . . . . . . 2992
Solve Linear Equations (multiple right hand) VI . . . . . . . . . . . . . . . . . 2995
Solve Complex Linear Equations (single right hand) VI . . . . . . . . . . . 2999
Solve Complex Linear Equations (multiple right hand) VI . . . . . . . . 3003
Dot Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3007
Real Dot Product VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3008
Complex Dot Product VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3009
Outer Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3010
Real Outer Product VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3010

52 ni.com
LabVIEW Programming Reference Manual

Complex Outer Product VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3011


A x B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3012
Real A x B VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3014
Complex A x B VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3016
A x Vector VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3018
Complex A x Vector VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3020
Vector x A VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3022
Complex Vector x A VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3024
Kronecker Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3027
Real Kronecker Product VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3027
Complex Kronecker Product VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3029
Subspaces Angle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3030
Subspaces Angle (1D) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3031
Subspaces Angle (2D 1D) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3032
Subspaces Angle (2D) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3033
Determinant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3034
Real Determinant VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3035
Complex Determinant VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3037
Vector Norm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3038
Real Vector Norm VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3039
Complex Vector Norm VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3040
Matrix Norm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3042
Real Matrix Norm VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3042
Complex Matrix Norm VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3044
Matrix Rank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3045
Real Matrix Rank VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3045
Complex Matrix Rank VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3046
Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3047
Real Matrix Trace VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3048
Complex Matrix Trace VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3049
Test Matrix Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3050
Test Real Matrix Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3052
Test Complex Matrix Type VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3055
Matrix Condition Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3057
Real Matrix Condition Number VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3058
Complex Matrix Condition Number VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3060

© National Instruments 53
LabVIEW Programming Reference Manual

Inverse Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3061


Real Inverse Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3062
Complex Inverse Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3064
PseudoInverse Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3066
Real PseudoInverse Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3067
Complex Pseudoinverse Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3068
Transpose Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3070
Real Transpose Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3070
Complex Conjugate Transpose Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . 3071
Matrix Square Root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3072
Real Matrix Square Root VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3072
Complex Matrix Square Root VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3072
Matrix Exp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3073
Real Matrix Exp VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3074
Complex Matrix Exp VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3075
Matrix Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3076
Real Matrix Power VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3076
Complex Matrix Power VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3077
Matrix Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3078
Real Matrix Logarithm VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3078
Complex Matrix Logarithm VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3079
LU Factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3080
Real LU Factorization VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3082
Complex LU Factorization VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3083
Cholesky Factorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3085
Real Cholesky Factorization VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3086
Complex Cholesky Factorization VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3087
Cholesky Factorization Rank-1 Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3088
Cholesky Factorization Rank-1 Update (DBL) VI . . . . . . . . . . . . . . . . . 3089
Cholesky Factorization Rank-1 Update (CDB) VI . . . . . . . . . . . . . . . . . 3090
QR Decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3091
Real QR Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3092
Complex QR Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3095
SVD Decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3097
Real SVD Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3098
Complex SVD Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3100

54 ni.com
LabVIEW Programming Reference Manual

Generalized SVD Decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3102


Real Generalized SVD Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . 3103
Complex Generalized SVD Decomposition VI . . . . . . . . . . . . . . . . . . . . 3105
Schur Decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3107
Real Schur Decomposition VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3108
Complex Schur Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3110
Hessenberg Decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3112
Real Hessenberg Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3113
Complex Hessenberg Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . 3114
QZ Decomposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3116
Real QZ Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3117
Complex QZ Decomposition VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3119
Sylvester Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3122
Real Sylvester Equations VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3122
Complex Sylvester Equations VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3125
Lyapunov Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3127
Real Lyapunov Equations VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3128
Complex Lyapunov Equations VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3130
Eigenvalues and Vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3131
Real Eigenvalues and Vectors VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3133
Complex Eigenvalues and Vectors VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3135
Generalized Eigenvalues and Vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3137
Real Generalized Eigenvalues and Vectors VI . . . . . . . . . . . . . . . . . . . . 3137
Complex Generalized Eigenvalues and Vectors VI . . . . . . . . . . . . . . . 3138
Matrix Balance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3139
Real Matrix Balance VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3141
Complex Matrix Balance VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3144
Back Transform Eigenvectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3147
Real Back Transform Eigenvectors VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3148
Complex Back Transform Eigenvectors VI . . . . . . . . . . . . . . . . . . . . . . 3150
Matrix Characteristic Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3152
Real Characteristic Polynomial VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3152
Complex Characteristic Polynomial VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3153
Basic Linear Algebra Subroutines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3154
ddot - Dot Product (DBL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3157
zdotu - Dot Product (CDB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3159

© National Instruments 55
LabVIEW Programming Reference Manual

zdotc - Dot Product with Conjugation (CDB) . . . . . . . . . . . . . . . . . . . . 3160


axpy - Scalar-Vector Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3162
daxpy - Scalar-Vector Product (DBL) VI . . . . . . . . . . . . . . . . . . . . 3162
zaxpy - Scalar-Vector Product (CDB) VI . . . . . . . . . . . . . . . . . . . . 3164
nrm2 - Vector 2-Norm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3165
dnrm2 - Vector 2-Norm (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3166
dznrm2 - Vector 2-Norm (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3167
asum - Absolute Values Sum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3168
dasum - Absolute Values Sum (DBL) VI . . . . . . . . . . . . . . . . . . . . 3168
dzasum - Absolute Values Sum (CDB) VI . . . . . . . . . . . . . . . . . . . 3169
copy - Vector Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3170
dcopy - Vector Copy (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3171
zcopy - Vector Copy (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3172
swap - Vector Swap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3174
dswap - Vector Swap (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3174
zswap - Vector Swap (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3176
drotm - Fast Givens Rotation (DBL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3177
drotmg - Fast Givens Rotation Parameters (DBL) . . . . . . . . . . . . . . . . 3179
rot - Givens Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3181
drot - Givens Rotation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3182
zdrot - Givens Rotation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3184
rotg - Givens Rotation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3186
drotg - Givens Rotation Parameters (DBL) VI . . . . . . . . . . . . . . . 3187
zrotg - Givens Rotation Parameters (CDB) VI . . . . . . . . . . . . . . . 3188
amax - Max Element Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3190
idamax - Max Element Index (DBL) VI. . . . . . . . . . . . . . . . . . . . . . 3190
izamax - Max Element Index (CDB) VI . . . . . . . . . . . . . . . . . . . . . . 3191
amin - Min Element Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3192
idamin - Min Element Index (DBL) VI . . . . . . . . . . . . . . . . . . . . . . 3193
izamin - Min Element Index (CDB) VI . . . . . . . . . . . . . . . . . . . . . . 3194
gemv - General Matrix-Vector Product . . . . . . . . . . . . . . . . . . . . . . . . . . 3195
dgemv - General Matrix-Vector Product (DBL) VI . . . . . . . . . . . . 3196
zgemv - General Matrix-Vector Product (CDB) VI . . . . . . . . . . . . 3197
dsymv - Symmetric Matrix-Vector Product (DBL) . . . . . . . . . . . . . . . . 3199
zhemv - Hermitian Matrix-Vector Product (CDB) . . . . . . . . . . . . . . . . . 3201
trmv - Triangle Matrix-Vector Product . . . . . . . . . . . . . . . . . . . . . . . . . . 3202

56 ni.com
LabVIEW Programming Reference Manual

dtrmv - Triangle Matrix-Vector Product (DBL) VI . . . . . . . . . . . . 3203


ztrmv - Triangle Matrix-Vector Product (CDB) VI . . . . . . . . . . . . 3204
dsyr - Symmetric Matrix Rank-1 Update (DBL) . . . . . . . . . . . . . . . . . . . 3206
dsyr2 - Symmetric Matrix Rank-2 Update (DBL). . . . . . . . . . . . . . . . . . 3207
zher - Hermitian Matrix Rank-1 Update (CDB) . . . . . . . . . . . . . . . . . . . 3209
zher2 - Hermitian Matrix Rank-2 Update (CDB) . . . . . . . . . . . . . . . . . . 3210
dger - General Matrix Rank-1 Update (DBL) . . . . . . . . . . . . . . . . . . . . . 3211
zgeru - General Matrix Rank-1 Update (CDB) . . . . . . . . . . . . . . . . . . . . 3212
zgerc - General Matrix Rank-1 Update with Conjugation (CDB) . . . . 3214
trsv - Solve Linear Eqs (Triangle, single) . . . . . . . . . . . . . . . . . . . . . . . . 3215
dtrsv - Solve Linear Eqs (Triangle, single) (DBL) VI . . . . . . . . . . 3215
ztrsv - Solve Linear Eqs (Triangle, single) (CDB) VI . . . . . . . . . . 3217
gemm - General Matrix-Matrix Product . . . . . . . . . . . . . . . . . . . . . . . . . 3218
dgemm - General Matrix-Matrix Product (DBL) VI . . . . . . . . . . . 3219
zgemm - General Matrix-Matrix Product (CDB) VI . . . . . . . . . . . 3221
symm - Symmetric Matrix-Matrix Product . . . . . . . . . . . . . . . . . . . . . . 3223
dsymm - Symmetric Matrix-Matrix Product (DBL) VI . . . . . . . . 3223
zsymm - Symmetric Matrix-Matrix Product (CDB) VI . . . . . . . . 3225
zhemm - Hermitian Matrix-Matrix Product (CDB) . . . . . . . . . . . . . . . . 3227
trmm - Triangle Matrix-Matrix Product . . . . . . . . . . . . . . . . . . . . . . . . . 3229
dtrmm - Triangle Matrix-Matrix Product (DBL) VI . . . . . . . . . . . 3229
ztrmm - Triangle Matrix-Matrix Product (CDB) VI . . . . . . . . . . . 3231
syrk - Symmetric Matrix Rank-k Update . . . . . . . . . . . . . . . . . . . . . . . . 3233
dsyrk - Symmetric Matrix Rank-k Update (DBL) VI . . . . . . . . . . 3234
zsyrk - Symmetric Matrix Rank-k Update (CDB) VI . . . . . . . . . . 3236
syr2k - Symmetric Matrix Rank-2k Update . . . . . . . . . . . . . . . . . . . . . . 3237
dsyr2k - Symmetric Matrix Rank-2k Update (DBL) VI . . . . . . . . 3238
zsyr2k - Symmetric Matrix Rank-2k Update (CDB) VI . . . . . . . . 3240
zherk - Hermitian Matrix Rank-k Update (CDB) . . . . . . . . . . . . . . . . . . 3242
zher2k - Hermitian Matrix Rank-2k Update (CDB) . . . . . . . . . . . . . . . . 3244
trsm - Solve Linear Eqs (Triangle, multiple) . . . . . . . . . . . . . . . . . . . . . 3246
dtrsm - Solve Linear Eqs (Triangle, multiple) (DBL) VI . . . . . . . 3246
ztrsm - Solve Linear Eqs (Triangle, multiple) (CDB) VI . . . . . . . 3248
Fitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3250
Linear Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3252
Exponential Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3257

© National Instruments 57
LabVIEW Programming Reference Manual

Power Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3263


Gaussian Peak Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3269
Logarithm Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3276
General Polynomial Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3281
General Linear Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3287
Cubic Spline Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3289
B-Spline Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3291
1D B-Spline Fit VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3293
nD B-Spline Fit VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3295
Fitting on a Sphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3297
Nonlinear Curve Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3298
Nonlinear Curve Fit LM VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3300
Nonlinear Curve Fit LM formula string VI . . . . . . . . . . . . . . . . . . . . . . . 3303
Constrained Nonlinear Curve Fit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3307
Nonlinear Curve Fit LM bound VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3307
Nonlinear Curve Fit TRDL bound VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3310
Curve Fitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3314
............................................................ 3318
Advanced Curve Fitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3320
Remove Outliers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3322
Remove Outliers (Range) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3322
Remove Outliers (Index) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3323
Goodness of Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3325
Nonlinear Curve Fit Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3326
Linear Fit Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3328
Confidence Interval (Linear) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3330
Prediction Interval (Linear) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3333
Exponential Fit Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3336
Confidence Interval (Exp) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3338
Prediction Interval (Exp) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3341
Power Fit Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3344
Confidence Interval (Power) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3346
Prediction Interval (Power) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3349
Gaussian Peak Fit Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3352
Confidence Interval (Gauss) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3354
Prediction Interval (Gauss) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3357

58 ni.com
LabVIEW Programming Reference Manual

Logarithm Fit Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3360


Confidence Interval (Log) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3362
Prediction Interval (Log) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3366
Polynomial Fit Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3369
Confidence Interval (Polynomial) VI . . . . . . . . . . . . . . . . . . . . . . . 3370
Prediction Interval (Polynomial) VI. . . . . . . . . . . . . . . . . . . . . . . . 3373
Linear Fit Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3376
Exponential Fit Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3378
Power Fit Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3379
Gaussian Peak Fit Coefficients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3381
Logarithm Fit Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3383
General Polynomial Fit Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3384
Interpolation & Extrapolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3387
Interpolate 1D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3389
Interpolate 2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3395
Interpolate 2D (2d X,Y) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3397
Interpolate 2D (1d X,Y) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3402
Interpolate 2D (1d xi,yi) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3406
Interpolate 2D Scattered. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3410
Interpolate 2D Scattered (1D) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3411
Interpolate 2D Scattered (2D) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3413
Create Mesh Grid (2D) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3415
Create Mesh Grid (2D) (x,y arrays) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3415
Create Mesh Grid (2D) (x array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3416
Spline Interpolation 1D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3417
Hermite Interpolation 1D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3421
Create Interpolating Polynomial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3422
Evaluate Interpolating Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3424
Interpolate 1D Fourier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3425
Search Ordered Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3426
Polynomial Interpolation VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3427
Rational Interpolation VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3428
Spline Interpolant VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3430
Spline Interpolation VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3433
Integration & Differentiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3435
Numeric Integration VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3436

© National Instruments 59
LabVIEW Programming Reference Manual

1D Numeric Integration VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3438


2D Numeric Integration VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3440
3D Numeric Integration VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3442
Uneven Numeric Integration VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3444
Quadrature VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3445
1D Quadrature (VI) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3447
1D Quadrature (Formula) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3449
2D Quadrature (VI) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3451
2D Quadrature (Formula) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3454
3D Quadrature (VI) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3456
3D Quadrature (Formula) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3458
Integral x(t) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3460
Derivative x(t) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3464
Time Domain Math. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3466
............................................................ 3469
Probability & Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3469
Mean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3472
Mean (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3473
Mean (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3474
Measures of Mean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3475
Standard Deviation and Variance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3476
Skewness and Kurtosis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3477
Measures of Spread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3480
Percentiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3480
st_Percentiles (scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3481
st_Percentiles (array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3481
RMS VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3482
RMS (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3483
RMS (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3484
MSE VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3485
Moment about Mean VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3486
Covariance Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3487
Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3488
Unimode VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3489
Multimode VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3491
Median . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3493

60 ni.com
LabVIEW Programming Reference Manual

Histogram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3494
General Histogram VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3497
Correlation Coefficient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3502
Correlation Coefficient (Spearman) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3503
Correlation Coefficient (Kendall's Tau) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3504
Probability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3505
Continuous CDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3507
Beta CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3508
Cauchy CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3509
Chi-Squared CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3510
Chi-Squared (Non-Central) CDF VI . . . . . . . . . . . . . . . . . . . . . . . . 3512
Exp CDF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3513
Extreme Value CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3514
F CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3515
Gamma CDF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3517
Laplace CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3518
Logistic CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3519
Lognormal CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3520
Normal CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3522
Pareto CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3523
Rayleigh CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3524
Student t CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3526
Triangular CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3527
Uniform CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3528
Weibull CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3530
Continuous Inverse CDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3531
Beta Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3532
Cauchy Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3533
Chi-Squared Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3534
Chi-Squared (Non-Central) Inverse CDF VI . . . . . . . . . . . . . . . . . 3535
Exp Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3536
Extreme Value Inverse CDF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3538
F Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3539
Gamma Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3540
Laplace Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3541
Logistic Inverse CDF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3542

© National Instruments 61
LabVIEW Programming Reference Manual

Lognormal Inverse CDF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3543


Normal Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3545
Pareto Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3546
Rayleigh Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3547
Student t Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3548
Triangular Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3549
Uniform Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3550
Weibull Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3551
Continuous PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3553
Beta PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3554
Cauchy PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3555
Chi-Squared PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3556
Chi-Squared (Non-Central) PDF VI . . . . . . . . . . . . . . . . . . . . . . . . 3556
Exp PDF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3557
Extreme Value PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3558
F PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3559
Gamma PDF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3560
Laplace PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3561
Logistic PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3562
Lognormal PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3563
Normal PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3564
Pareto PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3565
Rayleigh PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3566
Student t PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3567
Triangular PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3568
Uniform PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3569
Weibull PDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3570
Continuous Random . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3571
Beta Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3572
Cauchy Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3573
Chi-Squared Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3574
Chi-Squared (Non-Central) Random VI . . . . . . . . . . . . . . . . . . . . 3575
Exp Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3576
Extreme Value Random VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3577
F Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3578
Gamma Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3580

62 ni.com
LabVIEW Programming Reference Manual

Laplace Random VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3581


Logistic Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3582
Lognormal Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3583
Normal Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3584
Pareto Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3585
Rayleigh Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3586
Student t Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3587
Triangular Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3588
Uniform Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3589
Weibull Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3590
Continuous Moments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3591
Beta Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3592
Chi-Squared Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3593
Chi-Squared (Non-Central) Moments VI . . . . . . . . . . . . . . . . . . . 3594
Exp Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3595
Extreme Value Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3596
F Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3597
Gamma Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3598
Laplace Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3599
Logistic Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3600
Lognormal Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3601
Normal Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3602
Pareto Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3604
Rayleigh Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3605
Student t Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3606
Triangular Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3607
Uniform Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3608
Weibull Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3609
Discrete CDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3610
Bernoulli CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3611
Binomial CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3612
Geometric CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3613
Hypergeometric CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3614
Neg Binomial CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3615
Poisson CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3617
Uniform (Discrete) CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3618

© National Instruments 63
LabVIEW Programming Reference Manual

Discrete Inverse CDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3619


Bernoulli Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3620
Binomial Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3621
Geometric Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3622
Hypergeometric Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3623
Neg Binomial Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3624
Poisson Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3625
Uniform (Discrete) Inverse CDF VI . . . . . . . . . . . . . . . . . . . . . . . . . 3626
Discrete PF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3627
Bernoulli PF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3628
Binomial PF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3629
Geometric PF VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3630
Hypergeometric PF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3631
Neg Binomial PF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3633
Poisson PF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3634
Uniform (Discrete) PF VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3635
Discrete Random . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3636
Bernoulli Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3636
Binomial Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3637
Geometric Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3638
Hypergeometric Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3639
Neg Binomial Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3641
Poisson Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3642
Random Permutation VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3643
Uniform (Discrete) Random VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3644
Discrete Moments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3645
Bernoulli Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3645
Binomial Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3646
Geometric Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3648
Hypergeometric Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3649
Neg Binomial Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3650
Poisson Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3651
Uniform (Discrete) Moments VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3652
Hypothesis Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3653
T Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3654
Z Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3657

64 ni.com
LabVIEW Programming Reference Manual

Correlation Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3659


Sign Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3661
Sign Test (median) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3661
Sign Test (paired samples) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3663
Wilcoxon Signed Rank Test. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3664
Wilcoxon Signed-Rank Test (mean) VI . . . . . . . . . . . . . . . . . . . . . 3665
Wilcoxon Signed-Rank Test (paired samples) VI . . . . . . . . . . . . 3666
Rank Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3668
Contingency Table VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3669
Analysis of Variance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3671
1D ANOVA VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3672
2D ANOVA VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3677
3D ANOVA VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3685
Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3694
............................................................ 3700
Create Histogram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3701
............................................................ 3703
Optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3704
Linear Programming Simplex Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3706
Quadratic Programming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3708
Quadratic Programming IP VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3708
Quadratic Programming AS VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3712
Unconstrained Optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3715
Quasi Newton VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3716
Conjugate Gradient VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3719
Downhill Simplex VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3721
Quasi Newton formula string VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3724
Conjugate Gradient formula string VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3727
Downhill simplex formula string VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3729
Constrained Nonlinear Optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3732
Global Optimization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3736
Brent with Derivatives 1D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3744
Golden Section 1D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3746
Conjugate Gradient nD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3748
Downhill Simplex nD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3750
Find All Minima 1D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3752

© National Instruments 65
LabVIEW Programming Reference Manual

Find All Minima nD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3755


Chebyshev Approximation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3757
Differential Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3759
Ordinary Differential Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3759
ODE Solver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3760
ODE Solver main VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3761
ODE Solver formula string VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3764
ODE Runge Kutta 4th Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3768
ODE Cash Karp 5th Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3771
ODE Euler Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3774
ODE Linear nth Order Numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3777
ODE Linear nth Order Symbolic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3780
ODE Linear System Numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3782
ODE Linear System Symbolic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3785
DAE Radau 5th Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3787
DAE Radau 5th Order (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3787
DAE Radau 5th Order (Formula) VI . . . . . . . . . . . . . . . . . . . . . . . . 3790
Partial Differential Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3794
Define PDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3795
Define 2D Helmholtz PDE (Numeric) VI . . . . . . . . . . . . . . . . . . . . 3796
Define 2D Helmholtz PDE (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . 3799
Define 1D Heat PDE (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3801
Define 1D Heat PDE (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3804
Define 2D Heat PDE (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3806
Define 2D Heat PDE (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3808
Define 1D Wave PDE (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3811
Define 1D Wave PDE (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3813
Define 2D Wave PDE (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3815
Define 2D Wave PDE (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3818
Define PDE Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3820
Define 2D Helmholtz PDE Domain (Rect) VI . . . . . . . . . . . . . . . . 3823
Define 2D Helmholtz PDE Domain (Polygon) VI . . . . . . . . . . . . . 3827
Define 1D Heat PDE Domain VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3831
Define 2D Heat PDE Domain (Rect) VI . . . . . . . . . . . . . . . . . . . . . 3835
Define 1D Wave PDE Domain VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3840
Define 2D Wave PDE Domain (Rect) VI . . . . . . . . . . . . . . . . . . . . . 3844

66 ni.com
LabVIEW Programming Reference Manual

Define PDE Boundary Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3849


Define 2D Helmholtz PDE BC (Numeric) VI . . . . . . . . . . . . . . . . . 3851
Define 2D Helmholtz PDE BC (VIRef) VI . . . . . . . . . . . . . . . . . . . . 3854
Define 1D Heat PDE BC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . 3856
Define 1D Heat PDE BC (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3859
Define 2D Heat PDE BC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . 3862
Define 2D Heat PDE BC (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3864
Define 1D Wave PDE BC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . 3867
Define 1D Wave PDE BC (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3870
Define 2D Wave PDE BC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . 3872
Define 2D Wave PDE BC (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3875
Define PDE Initial Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3878
Define 1D Heat PDE IC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . . 3879
Define 1D Heat PDE IC (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3881
Define 2D Heat PDE IC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . . 3882
Define 2D Heat PDE IC (VIRef) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3884
Define 1D Wave PDE IC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . 3885
Define 1D Wave PDE IC (VIRef) VI. . . . . . . . . . . . . . . . . . . . . . . . . . 3887
Define 2D Wave PDE IC (Numeric) VI . . . . . . . . . . . . . . . . . . . . . . 3889
Define 2D Wave PDE IC (VIRef) VI. . . . . . . . . . . . . . . . . . . . . . . . . . 3891
PDE Solver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3892
2D Helmholtz PDE Solver (Rect Domain) VI . . . . . . . . . . . . . . . . 3894
2D Helmholtz PDE Solver (Polygon Domain) VI . . . . . . . . . . . . . 3895
1D Heat PDE Solver VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3897
2D Heat PDE Solver (Rect Domain) VI. . . . . . . . . . . . . . . . . . . . . . 3899
1D Wave PDE Solver VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3901
2D Wave PDE Solver (Rect Domain) VI . . . . . . . . . . . . . . . . . . . . . 3903
PDE Rendering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3904
2D Helmholtz PDE Rendering (Rect Domain) VI. . . . . . . . . . . . . 3905
2D Helmholtz PDE Rendering (Polygon Domain) VI . . . . . . . . . 3908
1D Heat PDE Rendering VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3910
2D Heat PDE Rendering (Rect Domain) VI . . . . . . . . . . . . . . . . . . 3912
1D Wave PDE Rendering VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3915
2D Wave PDE Rendering (Rect Domain) VI . . . . . . . . . . . . . . . . . 3917
Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3920
2D Cartesian Coordinate Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3921

© National Instruments 67
LabVIEW Programming Reference Manual

2D Cartesian Coordinate Shift (Array) VI . . . . . . . . . . . . . . . . . . . . . . . . 3922


2D Cartesian Coordinate Shift (Scalar) VI . . . . . . . . . . . . . . . . . . . . . . . 3923
2D Cartesian Coordinate Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3925
2D Cartesian Coordinate Rotation (Array) VI . . . . . . . . . . . . . . . . . . . . 3926
2D Cartesian Coordinate Rotation (Scalar) VI. . . . . . . . . . . . . . . . . . . . 3928
3D Cartesian Coordinate Shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3929
3D Cartesian Coordinate Shift (Array) VI . . . . . . . . . . . . . . . . . . . . . . . . 3930
3D Cartesian Coordinate Shift (Scalar) VI . . . . . . . . . . . . . . . . . . . . . . . 3932
3D Cartesian Coordinate Rotation (Euler) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3934
3D Cartesian Coordinate Rotation (Euler) (Array) VI . . . . . . . . . . . . . . 3935
3D Cartesian Coordinate Rotation (Euler) (Scalar) VI . . . . . . . . . . . . . 3938
3D Cartesian Coordinate Rotation (Direction) . . . . . . . . . . . . . . . . . . . . . . . . 3941
3D Cartesian Coordinate Rotation (Direction) (Array) VI . . . . . . . . . . 3943
3D Cartesian Coordinate Rotation (Direction) (Scalar) VI . . . . . . . . . 3945
Cross Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3947
Euler Angles To Direction Cosines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3949
Direction Cosines To Euler Angles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3950
3D Coordinate Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3952
3D Coordinate Conversion (Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 3953
3D Coordinate Conversion (Scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3955
Angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3958
Wrap Angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3959
Wrap Angle (scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3960
Wrap Angle (array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3961
Complementary Angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3962
Complementary Angle (scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . 3963
Complementary Angle (array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3964
Supplementary Angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3965
Supplementary Angle (scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3965
Supplementary Angle (array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 3966
Angle Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3967
Angle Rotation (scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3968
Angle Rotation (array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3969
Angle Rotation with Same Angle (array) VI . . . . . . . . . . . . . . . . . 3970
Bisect Angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3972
Bisect Angle (scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3972

68 ni.com
LabVIEW Programming Reference Manual

Bisect Angle (array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3974


Check for Included Angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3975
Check for Included Angle (scalar) VI . . . . . . . . . . . . . . . . . . . . . . . 3976
Check for Included Angle (array) VI . . . . . . . . . . . . . . . . . . . . . . . 3979
Absolute Angle Difference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3981
Absolute Angle Difference (scalar) VI . . . . . . . . . . . . . . . . . . . . . . 3982
Absolute Angle Difference (array) VI . . . . . . . . . . . . . . . . . . . . . . . 3983
Computational Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3984
Contour Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3985
Contour Line (Number of Heights) VI . . . . . . . . . . . . . . . . . . . . . . 3986
Contour Line (Scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3989
Contour Line (Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3991
Polygon Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3994
Point in Polygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3995
Point in Polygon (Scalar) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3995
Point in Polygon (Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3997
Polygon Centroid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3998
Delaunay Triangulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3999
Voronoi Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4000
Convex Hull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4001
Convex Polygon Intersection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4002
Polynomial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4004
Add Polynomials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4007
Add Polynomials (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4008
Add Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4009
Subtract Polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4010
Subtract Polynomials (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4010
Subtract Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4012
Multiply Polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4013
Multiply Polynomials (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4013
Multiply Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4014
Divide Polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4015
Divide Polynomials (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4016
Divide Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4017
Polynomials Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4018
Polynomials Composition (DBL) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4019

© National Instruments 69
LabVIEW Programming Reference Manual

Polynomials Composition (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4021


GCD of P(x) and Q(x) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4023
GCD of P(x) and Q(x) (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4023
GCD of P(x) and Q(x) (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4024
LCM of P(x) and Q(x) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4025
LCM of P(x) and Q(x) (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4025
LCM of P(x) and Q(x) (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4027
nth Derivative of Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4028
nth Derivative of Polynomial (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 4028
nth Derivative of Polynomial (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 4029
Indefinite Integral of Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4030
Indefinite Integral of Polynomial (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . 4030
Indefinite Integral of Polynomial (CDB) VI . . . . . . . . . . . . . . . . . . . . . . 4030
Integral of Polynomial over [a,b] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4031
Polynomial Roots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4032
Polynomial Roots (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4032
Polynomial Roots (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4033
Polynomial Real Zeros Counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4034
Roots Classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4036
Sort Complex Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4037
Unique Numbers and Multiplicity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4039
Unique Numbers and Multiplicity (DBL) VI . . . . . . . . . . . . . . . . . . . . . . 4039
Unique Numbers and Multiplicity (CDB) VI . . . . . . . . . . . . . . . . . . . . . . 4040
Create Polynomial From Roots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4040
Create Polynomial From Roots (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . 4041
Create Polynomial From Roots (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . 4042
Remove Zero Coefficients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4043
Remove Zero Coefficients (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4043
Remove Zero Coefficients (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4044
Order of Polynomial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4045
Order of Polynomial (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4046
Order of Polynomial (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4046
Polynomial Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4047
Polynomial Plot (Samples) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4047
Polynomial Plot (Range) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4048
Linear Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4049

70 ni.com
LabVIEW Programming Reference Manual

1D Linear Evaluation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4049


1D Linear Evaluation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4050
2D Linear Evaluation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4051
2D Linear Evaluation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4052
Polynomial Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4053
Scalar Polynomial Evaluation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4053
Scalar Polynomial Evaluation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4054
1D Polynomial Evaluation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4054
1D Polynomial Evaluation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4055
2D Polynomial Evaluation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4056
2D Polynomial Evaluation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4056
Evaluate Polynomial with Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4057
Evaluate Polynomial with Matrix (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . 4058
Evaluate Polynomial with Matrix (CDB) VI. . . . . . . . . . . . . . . . . . . . . . . 4059
Partial Fraction Expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4060
Create Polynomial From PFE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4061
Polynomial Eigenvalues and Vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4063
Polynomial Eigenvalues and Vectors (DBL) VI . . . . . . . . . . . . . . . . . . . 4064
Polynomial Eigenvalues and Vectors (CDB) VI . . . . . . . . . . . . . . . . . . . 4065
Orthogonal & Non-orthogonal Polynomials . . . . . . . . . . . . . . . . . . . . . . . . . 4067
Create Orthogonal Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4068
Bessel Polynomial VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4069
Chebyshev Polynomial VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4070
Legendre Polynomial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4071
Rational Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4073
Add Rational Polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4075
Add Rational Polynomials (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . 4076
Add Rational Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . 4077
Subtract Rational Polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4079
Subtract Rational Polynomials (DBL) VI . . . . . . . . . . . . . . . . . . . 4080
Subtract Rational Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . 4082
Multiply Rational Polynomials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4084
Multiply Rational Polynomials (DBL) VI . . . . . . . . . . . . . . . . . . . . 4084
Multiply Rational Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . . 4086
Divide Rational Polynomials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4088
Divide Rational Polynomials (DBL) VI. . . . . . . . . . . . . . . . . . . . . . 4088

© National Instruments 71
LabVIEW Programming Reference Manual

Divide Rational Polynomials (CDB) VI . . . . . . . . . . . . . . . . . . . . . 4090


Negative Feedback with Rational Polynomials . . . . . . . . . . . . . . . . . . 4092
Negative Feedback with Rational Polynomials (DBL) VI . . . . . 4093
Negative Feedback with Rational Polynomials (CDB) VI . . . . . 4094
Positive Feedback with Rational Polynomials . . . . . . . . . . . . . . . . . . . 4095
Positive Feedback with Rational Polynomials (DBL) VI . . . . . . 4096
Positive Feedback with Rational Polynomials (CDB) VI . . . . . . 4097
Pade Approximation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4099
Normalize with Highest Den Term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4100
Normalize with Highest Den Term (DBL) VI. . . . . . . . . . . . . . . . . 4101
Normalize with Highest Den Term (CDB) VI . . . . . . . . . . . . . . . . 4102
Normalize with Lowest Den Term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4103
Normalize with Lowest Den Term (DBL) VI . . . . . . . . . . . . . . . . . 4104
Normalize with Lowest Den Term (CDB) VI . . . . . . . . . . . . . . . . . 4105
Remove Residue from Denominator . . . . . . . . . . . . . . . . . . . . . . . . . . . 4107
Remove Residue from Denominator (DBL) VI . . . . . . . . . . . . . . 4107
Remove Residue from Denominator (CDB) VI . . . . . . . . . . . . . . 4108
1D Rational Polynomial Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4109
1D Rational Polynomial Evaluation (DBL) VI. . . . . . . . . . . . . . . . 4109
1D Rational Polynomial Evaluation (CDB) VI . . . . . . . . . . . . . . . 4110
nth Derivative of Rational Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . 4111
nth Derivative of Rational Polynomial (DBL) VI . . . . . . . . . . . . . 4111
nth Derivative of Rational Polynomial (CDB) VI . . . . . . . . . . . . . 4112
Partial Fraction Expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4113
Create Polynomial From PFE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4115
Scripts & Formulas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4117
Formula Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4118
Script Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4119
MATLAB script node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4119
Formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4120
............................................................ 4124
Formula Parsing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4128
Parse Formula String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4128
Parse Formula Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4129
Substitute Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4131
Expression Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4132

72 ni.com
LabVIEW Programming Reference Manual

1D & 2D Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4133


Eval Formula String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4136
Eval Single-Variable Scalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4137
Eval Single-Variable Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4138
Eval Multi-Variable Scalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4139
Eval Multi-Variable Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4140
Eval Parsed Formula String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4142
Eval Formula Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4143
Eval Parsed Formula Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4144
Eval y=f(x) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4146
Eval y=f(x) Optimal Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4147
Eval y=f(a,x) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4149
Eval y=f(x1,x2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4150
Eval y=f(a,x1,x2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4152
Eval X-Y-Z(t1,t2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4154
Eval X-Y-Z(a,t1,t2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4156
Eval X-Y(t) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4158
Eval X-Y(t) Optimal Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4160
Eval X-Y(a,t) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4161
Eval Polar to Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4163
Eval Polar to Rect Optimal Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4165
Calculus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4166
Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4167
Differentiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4169
Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4171
Curve Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4173
Partial Derivatives of f(x1,x2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4174
Extrema of f(x1,x2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4176
Zeros and Extrema of f(x) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4178
Zeros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4180
Find All Zeros of f(x) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4181
Find All Zeros of f(x) (Formula) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4182
Find All Zeros of f(x) (VI) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4185
Newton Raphson Zero Finder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4187
Newton Raphson Zero Finder (Formula) VI . . . . . . . . . . . . . . . . 4188
Newton Raphson Zero Finder (VI) VI. . . . . . . . . . . . . . . . . . . . . . . 4190

© National Instruments 73
LabVIEW Programming Reference Manual

Ridders Zero Finder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4192


Ridders Zero Finder (Formula) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4193
Ridders Zero Finder (VI) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4195
nD Nonlinear System Single Solution . . . . . . . . . . . . . . . . . . . . . . . . . . 4196
nD Nonlinear System Single Solution (Formula) VI . . . . . . . . . 4197
nD Nonlinear System Single Solution (VI) VI. . . . . . . . . . . . . . . . 4199
nD Nonlinear System Solver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4201
nD Nonlinear System Solver (Formula) VI . . . . . . . . . . . . . . . . . . 4203
nD Nonlinear System Solver (VI) VI . . . . . . . . . . . . . . . . . . . . . . . . 4205
Additional Information about the Mathematics VIs . . . . . . . . . . . . . . . . . . . . . . . . 4208
Differences between the Parser in the Mathematics VIs and the Formula
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4208
Mathematics Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4210
Mathematics VIs and Functions for the LabVIEW Base Development
System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4211
Mathematics VIs Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4212
Output Values for Invalid Operations with Matrix Functions . . . . . . . . . . . 4215
Probability Distributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4215
Special Matrix Coercion Cases for the Matrix Functions . . . . . . . . . . . . . . . 4216
Creating the Formula String or Fitting Model to Specify a Nonlinear
Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4216
Formula Parsing VIs in More Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4218
Formula Parsing VI Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4219
Signal Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4220
Waveform Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4221
Waveform Conditioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4224
Digital FIR Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4226
FIR Filter for 1 Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4227
FIR Filter for N Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4232
FIR Filter by N Specs for N Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4237
FIR Filter for 1 Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4242
FIR Filter for N Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4247
FIR Filter by N Specs for N Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . 4252
Digital IIR Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4257
IIR Filter for 1 Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4259
IIR Filter for N Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4265

74 ni.com
LabVIEW Programming Reference Manual

IIR Filter by N Specs for N Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4270


IIR Filter for 1 Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4276
IIR Filter for N Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4282
IIR Filter by N Specs for N Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . 4287
Continuous Convolution (FIR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4293
Continuous Waveform Convolution for 1 Chan VI . . . . . . . . . . . . . . . . 4294
Continuous Waveform Convolution for N Chan VI . . . . . . . . . . . . . . . 4295
Scaled Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4296
Scaled Window for 1 Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4299
Scaled Window for N Chan VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4303
Scaled Window for 1 Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4307
Scaled Window for N Chan (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4311
Align Waveforms (continuous) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4314
Align N Waveforms (continuous) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4315
Align M + N Waveforms (continuous) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4317
Align N + 1 Waveforms (continuous) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4319
Align 1 + N Waveforms (continuous) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4321
Align two Waveforms (continuous) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 4323
Align Waveforms (single shot) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4325
Align N Waveforms (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4325
Align M + N Waveforms (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4327
Align N + 1 Waveforms (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 4329
Align 1 + N Waveforms (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 4332
Align two Waveforms (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 4334
Resample Waveforms (continuous) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4336
Resample Waveform (continuous) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 4337
Resample N Waveforms (continuous) VI . . . . . . . . . . . . . . . . . . . . . . . . 4339
Resample Waveform (continuous, t0 DBL) VI . . . . . . . . . . . . . . . . . . . . 4342
Resample N Waveforms (continuous, t0 DBL) VI . . . . . . . . . . . . . . . . . 4344
Resample Waveforms (single shot) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4347
Resample Waveform (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 4347
Resample N Waveforms (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . 4349
Resample Array of Pairs (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . 4352
Resample Pair of Arrays (single shot) VI . . . . . . . . . . . . . . . . . . . . . . . . 4354
Resample N Arrays of Pairs (single shot) VI . . . . . . . . . . . . . . . . . . . . . . 4357
Resample N Pairs of Arrays (single shot) VI . . . . . . . . . . . . . . . . . . . . . . 4360

© National Instruments 75
LabVIEW Programming Reference Manual

Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4362
............................................................ 4367
Align and Resample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4370
............................................................ 4374
Trigger and Gate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4375
Waveform Measurements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4380
Signal Generation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4383
Signal Generator by Duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4386
Tones and Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4389
Gaussian Modulated Sine Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4391
Gaussian Monopulse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4393
Sinc Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4395
Periodic Sinc Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4397
Sine Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4398
Triangle Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4400
Pulse Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4402
Ramp Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4403
Ramp Pattern by Samples VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4405
Ramp Pattern by Delta VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4407
Chirp Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4410
Sine Wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4411
Triangle Wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4413
Square Wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4415
Sawtooth Wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4417
Arbitrary Wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4420
Uniform White Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4422
Gaussian White Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4424
Periodic Random Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4427
Binary MLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4428
Impulse Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4431
Gamma Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4432
Poisson Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4434
Binomial Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4436
Bernoulli Noise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4438
Pulse Train . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4440
Quasi Random . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4443

76 ni.com
LabVIEW Programming Reference Manual

Halton Sequence VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4444


Richtmeyer Sequence VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4445
Signal Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4447
Convolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4451
1D Convolution (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4455
1D Convolution (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4458
2D Convolution (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4461
2D Convolution (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4465
Deconvolution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4468
AutoCorrelation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4470
1D Auto Correlation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4473
1D Auto Correlation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4476
2D Auto Correlation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4479
2D Auto Correlation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4480
CrossCorrelation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4481
1D Cross Correlation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4485
1D Cross Correlation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4489
2D Cross Correlation (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4492
2D Cross Correlation (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4494
AutoCorrelation Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4496
AutoCorrelation Matrix (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4498
AutoCorrelation Matrix (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4502
Y[i]=X[i-n] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4505
Zero Padder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4506
Zero Padder (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4507
Zero Padder (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4508
Unwrap Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4508
Digital Reversed Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4510
Digital Reversed Order (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4511
Digital Reversed Order (CDB) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4513
Digital Reversed Order (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4514
Decimate (single shot). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4516
Decimate (single shot, DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4517
Decimate (single shot, CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4518
Decimate (continuous) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4520
Decimate (continuous, DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4521

© National Instruments 77
LabVIEW Programming Reference Manual

Decimate (continuous, CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4523


Upsample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4526
Upsample (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4526
Upsample (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4527
Rational Resample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4529
Rational Resample (single channel, DBL) VI . . . . . . . . . . . . . . . . . . . . . 4531
Rational Resample (single channel, CDB) VI . . . . . . . . . . . . . . . . . . . . 4535
Rational Resample (multi-channel, DBL) VI . . . . . . . . . . . . . . . . . . . . . 4539
Rational Resample (multi-channel, CDB) VI . . . . . . . . . . . . . . . . . . . . . 4543
Resample (constant to constant) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4547
Resample (constant to constant,single -channel) VI . . . . . . . . . . . . . 4547
Resample (constant to constant,multi-channel) VI . . . . . . . . . . . . . . 4549
Resample (constant to constant, complex single-channel) VI . . . . . 4551
Resample (constant to constant, complex multi-channel) VI . . . . . . 4553
Resample (constant to variable) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4555
Resample (constant to variable,single-channel) VI . . . . . . . . . . . . . . 4556
Resample (constant to variable, multi-channel) VI . . . . . . . . . . . . . . . 4558
Resample (constant to variable, complex single-channel) VI . . . . . . 4561
Resample (constant to variable, complex multi-channel) VI . . . . . . 4563
Unit Vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4565
Unit Vector (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4566
Unit Vector (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4567
Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4569
Scale 1D VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4570
Scale 2D VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4571
Quick Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4573
Quick Scale 1D VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4574
Quick Scale 2D VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4575
Normalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4576
Normalize Vector VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4577
Normalize Matrix VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4578
Y[i]=Clip{X[i]} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4580
Riffle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4581
Riffle Array (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4581
Riffle Array (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4582
Riffle Array (I32) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4583

78 ni.com
LabVIEW Programming Reference Manual

AC & DC Estimator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4584


Peak Detector VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4585
Threshold Detector VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4588
Convolution and Correlation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4590
............................................................ 4592
Scaling and Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4593
............................................................ 4595
Z-Transform Delay Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4596
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4596
Scaled Time Domain Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4599
Scaled Time Domain Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4601
Scaled Time Domain Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . 4604
Symmetric Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4607
Symmetric Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4607
Symmetric Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4609
Window Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4611
Window Properties by Coef VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4612
Window Properties by Name VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4613
Hanning Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4614
Hanning Window (DBL) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4615
Hanning Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4616
Hamming Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4617
Hamming Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4617
Hamming Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4619
Blackman Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4620
Blackman Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4620
Blackman Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4621
Blackman-Harris Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4622
Blackman-Harris Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4623
Blackman-Harris Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4624
Blackman-Nuttall Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4625
Blackman-Nuttall Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4626
Blackman-Nuttall Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4627
Exact Blackman Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4628
Exact Blackman Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4629
Exact Blackman Window (CDB) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4630

© National Instruments 79
LabVIEW Programming Reference Manual

Flat Top Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4631


Flat Top Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4632
Flat Top Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4633
General Cosine Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4634
General Cosine Window (DBL) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4635
General Cosine Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4636
Cosine Tapered Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4637
Cosine Tapered Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4639
Cosine Tapered Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4640
Triangle Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4642
Triangle Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4643
Triangle Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4644
Kaiser-Bessel Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4645
Kaiser-Bessel Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4646
Kaiser-Bessel Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4647
Gaussian Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4648
Gaussian Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4649
Gaussian Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4650
Chebyshev Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4651
Chebyshev Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4652
Chebyshev Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4653
Force Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4655
Force Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4655
Force Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4657
Exponential Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4658
Exponential Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4659
Exponential Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4660
Modified Bartlett-Hanning Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4661
Modified Bartlett-Hanning Window (DBL) VI . . . . . . . . . . . . . . . . . . . . 4662
Modified Bartlett-Hanning Window (CDB) VI . . . . . . . . . . . . . . . . . . . . 4663
Bohman Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4664
Bohman Window (DBL) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4665
Bohman Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4666
Parzen Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4667
Parzen Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4667
Parzen Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4668

80 ni.com
LabVIEW Programming Reference Manual

Welch Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4669


Welch Window (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4670
Welch Window (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4671
Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4672
Butterworth Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4675
Butterworth Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4676
Butterworth Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4678
Chebyshev Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4680
Chebyshev Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4681
Chebyshev Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4684
Inverse Chebyshev Filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4686
Inverse Chebyshev Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4687
Inverse Chebyshev Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4690
Elliptic Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4692
Elliptic Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4693
Elliptic Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4695
Bessel Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4698
Bessel Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4699
Bessel Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4701
Equi-Ripple LowPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4704
Equi-Ripple LowPass (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4705
Equi-Ripple LowPass (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4706
Equi-Ripple HighPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4708
Equi-Ripple HighPass (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4709
Equi-Ripple HighPass (CDB) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4711
Equi-Ripple BandPass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4713
Equi-Ripple BandPass (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4713
Equi-Ripple BandPass (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4716
Equi-Ripple BandStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4718
Equi-Ripple BandStop (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4719
Equi-Ripple BandStop (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4721
Inverse f Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4724
Inverse f Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4724
Inverse f Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4727
Zero Phase Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4730
Zero Phase Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4731

© National Instruments 81
LabVIEW Programming Reference Manual

Zero Phase Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4733


Zero Phase Filter (Cascade, DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4734
Zero Phase Filter (Cascade, CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4736
FIR Windowed Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4738
FIR Windowed Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4739
FIR Windowed Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4742
Median Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4745
Savitzky-Golay Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4747
Savitzky-Golay Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4747
Savitzky-Golay Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4749
Mathematical Morphological Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4750
Advanced IIR Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4754
Butterworth Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4756
Chebyshev Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4759
Inv Chebyshev Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4761
Elliptic Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4764
Bessel Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4766
Butterworth Order Estimation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4769
Chebyshev Order Estimation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4772
Inverse Chebyshev Order Estimation . . . . . . . . . . . . . . . . . . . . . . . . . . . 4775
Elliptic Order Estimation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4778
Smoothing Filter Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4781
Inverse f Filter Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4783
IIR Cascade Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4786
IIR Cascade Filter (DBL) VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4787
IIR Cascade Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4789
IIR Cascade Filter with I.C. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4790
IIR Cascade Filter with I.C. (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . 4791
IIR Cascade Filter with I.C. (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . 4792
IIR Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4794
IIR Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4795
IIR Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4797
IIR Filter with I.C.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4798
IIR Filter with I.C. (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4799
IIR Filter with I.C. (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4801
Cascade To Direct Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4803

82 ni.com
LabVIEW Programming Reference Manual

Advanced FIR Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4805


FIR Windowed Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4806
Parks-McClellan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4809
Savitzky-Golay Filter Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4812
FIR Narrowband Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4815
Convolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4818
FIR Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4822
FIR Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4823
FIR Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4824
FIR Filter with I.C. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4825
FIR Filter with I.C. (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4826
FIR Filter with I.C. (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4827
FIR Narrowband Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4828
FIR Narrowband Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 4829
FIR Narrowband Filter (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 4831
Spectral Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4833
Auto Power Spectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4834
Power Spectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4835
Power Spectrum (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4840
Power Spectrum (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4844
Cross Power Spectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4849
Unevenly Sampled Signal Spectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4850
Amplitude and Phase Spectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4853
Spectrum Unit Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4855
STFT Spectrograms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4858
WVD Spectrogram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4863
Cross Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4866
Cross Power (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4868
Cross Power (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4871
Power & Frequency Estimate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4873
Buneman Frequency Estimator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4875
Transforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4876
FFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4879
Real FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4883
Complex FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4887
2D Real FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4891

© National Instruments 83
LabVIEW Programming Reference Manual

2D Complex FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4893


Fast Hilbert Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4895
FHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4898
Wavelet Transform Daubechies4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4899
Walsh Hadamard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4901
DCT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4902
1D DCT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4904
2D DCT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4906
DST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4907
1D DST VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4908
2D DST VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4909
Chirp Z Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4910
Chirp Z Transform (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4913
Chirp Z Transform (CDB) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4917
Laplace Transform Real . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4921
Inverse FFT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4923
Inverse Real FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4925
Inverse Complex FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4927
2D Inverse Real FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4929
2D Inverse Complex FFT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4931
Inverse Fast Hilbert Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4933
Inverse FHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4935
Wavelet Transform Daubechies4 Inverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4936
Walsh Hadamard Inverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4938
Inverse DCT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4939
1D Inverse DCT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4940
2D Inverse DCT VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4942
Inverse DST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4943
1D Inverse DST VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4944
2D Inverse DST VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4945
Inverse Chirp Z Transform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4946
Point By Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4949
Signal Generation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4950
Sine Wave PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4951
Triangle Wave PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4952
Square Wave PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4954

84 ni.com
LabVIEW Programming Reference Manual

Sawtooth Wave PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4955


Uniform White Noise PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4956
Gaussian White Noise PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4957
Periodic Random Noise PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4958
Signal Operation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4959
Convolution PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4961
Deconvolution PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4962
AutoCorrelation PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4964
CrossCorrelation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4965
Y[i]=X[i-n] PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4966
Unwrap Phase PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4967
Unit Vector PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4968
Scale 1D PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4969
Quick Scale 1D PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4970
Normalize Vector PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4971
Y[i]=Clip{X[i]} PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4972
AC & DC Estimator PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4973
Peak Detector PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4974
Threshold Detector PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4976
Filters PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4977
Butterworth Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4979
Chebyshev Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4981
Inverse Chebyshev Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4983
Elliptic Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4986
Bessel Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4988
Equi-Ripple LowPass PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4990
Equi-Ripple HighPass PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4992
Equi-Ripple BandPass PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4993
Equi-Ripple BandStop PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4996
FIR Windowed Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4998
Median Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5001
FIR Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5002
IIR Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5003
IIR Filter with I.C. PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5004
IIR Cascade Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5006
IIR Cascade Filter with I.C. PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5008

© National Instruments 85
LabVIEW Programming Reference Manual

Savitzky Golay Filter PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5009


Spectral Analysis PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5011
Auto Power Spectrum PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5012
Power Spectrum PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5013
Amplitude and Phase Spectrum PtByPt . . . . . . . . . . . . . . . . . . . . . . . . 5014
Cross Power Spectrum PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5016
Cross Power PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5017
STFT Spectrogram PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5018
WVD Spectrogram PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5020
Buneman Frequency Estimator PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . 5022
Transforms PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5023
FFT PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5024
Real FFT PtByPt VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5025
Complex FFT PtByPt VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5026
Fast Hilbert Transform PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5027
FHT PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5028
Walsh Hadamard PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5029
Wavelet Transform Daubechies4 PtByPt . . . . . . . . . . . . . . . . . . . . . . . . 5030
Windowed FFT PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5031
Inverse FFT PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5032
Inverse Real FFT PtByPt VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5033
Inverse Complex FFT PtByPt VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 5034
Inverse Fast Hilbert Transform PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . 5035
Inverse FHT PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5037
Walsh Hadamard Inverse PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5038
Wavelet Transform Daubechies4 Inverse PtByPt . . . . . . . . . . . . . . . . 5039
Transfer Function PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5040
Impulse Response Function PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5041
Linear Algebra PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5042
Dot Product PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5043
Outer Product PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5044
Complex Dot Product PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5045
Complex Outer Product PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5046
Fitting PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5048
Linear Fit PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5049
Linear Fit Coefficients PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5051

86 ni.com
LabVIEW Programming Reference Manual

Exponential Fit PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5052


Exponential Fit Coefficients PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5054
General Polynomial Fit PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5056
General LS Linear Fit PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5058
Interpolation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5061
Polynomial Interpolation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5062
Rational Interpolation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5063
Spline Interpolant PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5065
Spline Interpolation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5066
Integral & Differential PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5068
Integral x(t) PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5068
Derivative x(t) PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5070
Probability & Statistics PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5071
Mean PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5073
Standard Deviation PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5074
Variance PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5075
Sample Variance PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5076
RMS PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5078
MSE PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5079
Moment about Mean PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5080
Median PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5081
Mode PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5082
Histogram PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5083
General Histogram PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5085
Geometry PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5088
1D Polar to Rectangular PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5089
1D Rectangular to Polar PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5090
Polynomial PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5091
1D Polynomial Evaluation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5091
1D Linear Evaluation PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5092
Other Functions PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5093
Search 1D Array PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5095
Sort 1D Array PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5096
Array Max & Min PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5096
Add Array Elements PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5098
Increment PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5099

© National Instruments 87
LabVIEW Programming Reference Manual

Decrement PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5100


Data Queue PtByPt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5101
Complex Queue PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5102
Boolean Crossing PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5104
Zero Crossing PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5105
Zero-Order Hold PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5106
Value Has Changed PtByPt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5106
Additional Information about the Signal Processing VIs . . . . . . . . . . . . . . . . . . . . 5108
Output Units for FFT-Based VIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5108
Characteristic Inputs and Outputs of the Point By Point VIs. . . . . . . . . . . . 5109
Initializing the Point By Point VIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5110
Data Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5112
Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5113
Open Variable Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5114
Read Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5116
Write Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5118
Close Variable Connection Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5119
Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5120
Local Variable Object Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5123
Variable Property Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5123
Search Variable Container Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5124
PSP Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5127
Open and Verify Variable Connection . . . . . . . . . . . . . . . . . . . . . . . . . . 5127
Open Variable Connection in Background . . . . . . . . . . . . . . . . . . . . . . 5129
Read Variable with Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5132
Flush Shared Variable Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5134
I/O Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5134
Scanned Variable Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5135
Scanned Variable Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5136
Direct Variable Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5137
Direct Variable Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5138
Network Streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5139
Create Network Stream Writer Endpoint Function . . . . . . . . . . . . . . . . . . . . 5140
Write Single Element to Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5142
Write Multiple Elements to Stream. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5143
Flush Stream Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5144

88 ni.com
LabVIEW Programming Reference Manual

Destroy Stream Endpoint Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5146


Create Network Stream Reader Endpoint Function . . . . . . . . . . . . . . . . . . . 5146
Read Single Element from Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5148
Read Multiple Elements from Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5150
Network Streams Property Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5151
Local Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5152
Global Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5152
Queue Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5153
Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5154
DataSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5155
DataSocket Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5156
DataSocket Write Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5160
DataSocket Select URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5161
DataSocket Open Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5163
DataSocket Close Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5164
Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5165
TCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5167
TCP Listen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5168
TCP Open Connection Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5170
TCP Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5172
TCP Write Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5174
TCP Close Connection Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5176
IP To String Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5177
String To IP Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5177
Resolve Machine Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5178
TCP Create Listener Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5179
TCP Wait On Listener Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5181
Transport Layer Security (TLS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5183
New TLS Configuration Function . . . . . . . . . . . . . . . . . . . . . . . . . 5184
Make TLS Configuration Immutable Function . . . . . . . . . . . . . . 5185
Close TLS Configuration Function . . . . . . . . . . . . . . . . . . . . . . . . 5186
TLS Connection? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5187
Load Certificates Into Memory Function . . . . . . . . . . . . . . . . . . . 5187
Add Trusted Certificate To TLS Configuration Function . . . . . . 5189
Start TLS Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5190
Load Private Key Into Memory Function . . . . . . . . . . . . . . . . . . . 5192

© National Instruments 89
LabVIEW Programming Reference Manual

Add Private Key To TLS Configuration Function . . . . . . . . . . . . 5193


Accept TLS Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5194
UDP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5196
UDP Open Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5196
UDP Multicast Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5198
UDP Multicast Read-Only Open VI . . . . . . . . . . . . . . . . . . . . . . . . 5199
UDP Multicast Read-Write Open VI . . . . . . . . . . . . . . . . . . . . . . . . 5200
UDP Multicast Write-Only Open VI . . . . . . . . . . . . . . . . . . . . . . . . 5202
UDP Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5204
UDP Write Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5205
UDP Close Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5207
Serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5208
IrDA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5209
IrDA Discover Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5210
IrDA Open Connection Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5211
IrDA Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5212
IrDA Write Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5215
IrDA Close Connection Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5216
IrDA Create Listener Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5217
IrDA Wait On Listener Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5218
Bluetooth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5219
Bluetooth Open Connection Function . . . . . . . . . . . . . . . . . . . . . . . . . . 5220
Bluetooth Read Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5222
Bluetooth Write Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5224
Bluetooth Close Connection Function . . . . . . . . . . . . . . . . . . . . . . . . . . 5225
Bluetooth Create Listener Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5226
Bluetooth Wait On Listener Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 5228
Bluetooth Discover Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5229
Bluetooth RFCOMM Service Discovery. . . . . . . . . . . . . . . . . . . . . . . . . . 5230
Bluetooth Set Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5232
Bluetooth Get Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5233
SMTP Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5234
Send Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5236
....................................................... 5238
Open Handle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5240
Close Handle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5241

90 ni.com
LabVIEW Programming Reference Manual

Set Recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5242


Set Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5243
Set Message Text VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5243
Set Message Text Html VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5244
Send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5246
Set Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5247
Clear Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5247
Set Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5248
Clear Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5249
Config TLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5250
HTTP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5252
OpenHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5254
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5256
HEAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5258
CloseHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5259
PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5260
PUTBuffer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5261
PUTFile VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5263
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5265
POSTBuffer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5266
POSTFile VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5268
POSTMultipart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5270
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5272
Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5274
ConfigSSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5275
SetAPIKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5278
ConfigKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5279
Encrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5280
Decrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5282
Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5283
AddHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5284
RemoveHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5286
GetHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5287
HeaderExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5288
ListHeaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5290
FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5291

© National Instruments 91
LabVIEW Programming Reference Manual

FTP Get Buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5292


FTP Get File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5294
FTP Get Multiple Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5296
FTP Get Multiple Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5297
FTP Get Multiple Files and Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5299
Intermediate FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5301
FTP Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5303
FTP Check Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5304
FTP Reply To Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5305
FTP Open Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5307
FTP Logon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5308
FTP Rename File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5310
FTP Close Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5311
FTP Directory Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5312
FTP Get Path Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5314
FTP Retrieve Multiple. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5316
FTP Store Multiple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5318
FTP Put Buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5320
FTP Put File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5321
FTP Put Multiple Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5323
FTP Put Multiple Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5325
FTP Put Multiple Files and Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5327
WebDAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5329
Simple Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5330
Simple Get Buffer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5331
Simple Get File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5332
Simple Get Multiple Buffers VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5333
Simple Get Multiple Files VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5335
Simple Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5336
Simple Put Buffer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5337
Simple Put File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5338
Simple Put Multiple Buffers VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5340
Simple Put Multiple Files VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5341
WebDAV Synchronous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5343
Open Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5345
Configure SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5347

92 ni.com
LabVIEW Programming Reference Manual

Close Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5348


Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5349
Get Buffer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5349
Get File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5350
Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5352
Put Buffer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5352
Put File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5353
Create Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5354
Directory Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5355
Path Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5357
Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5359
Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5360
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5362
WebDAV Asynchronous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5362
Asynchronous Open Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5365
Asynchronous Configure SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5368
Asynchronous Create Event Registration . . . . . . . . . . . . . . . . . . 5370
Asynchronous Close Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5371
Asynchronous Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5371
Asynchronous Get Buffer VI . . . . . . . . . . . . . . . . . . . . . . . . . 5372
Asynchronous Get File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 5373
Asynchronous Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5375
Asynchronous Put Buffer VI . . . . . . . . . . . . . . . . . . . . . . . . . 5375
Asynchronous Put File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 5377
Asynchronous Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5378
Asynchronous Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5380
Asynchronous Create Directory. . . . . . . . . . . . . . . . . . . . . . . . . . . 5381
Asynchronous Directory Listing . . . . . . . . . . . . . . . . . . . . . . . . . . 5382
Asynchronous Path Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5384
Asynchronous Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5385
Asynchronous Request Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5386
Asynchronous Abort Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5388
Asynchronous Close Request Handle . . . . . . . . . . . . . . . . . . . . . 5389
Wait for Configured Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5389
SFTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5392
Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5393

© National Instruments 93
LabVIEW Programming Reference Manual

Connect (OpenSSH) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5394


Connect (PuTTY) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5395
Connect (Generic) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5396
Disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5397
Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5398
Upload File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5398
Upload File from Buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5399
Upload File from Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5400
Upload Multiple Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5402
Download VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5403
Download File VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5403
Download File To Buffer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5404
Download File to Stream VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5405
Download Multiple Files VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5406
Delete File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5408
Rename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5408
Create Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5410
List Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5411
Delete Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5412
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5413
Get File Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5414
SFTP File Attributes Property Node . . . . . . . . . . . . . . . . . . . . . . . 5415
Set File Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5416
Read Filesystem Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5417
SFTP Filesystem Statistics Property Node . . . . . . . . . . . . . . . . . 5418
SFTP Session Property Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5419
Create Symbolic Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5420
Read Symbolic Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5421
Canonicalize Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5422
Channel Wire Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5423
Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5424
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5424
Write Multiple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5425
Write Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5427
Write With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5428
Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5430

94 ni.com
LabVIEW Programming Reference Manual

Read Multiple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5431


Read Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5433
Read With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5434
Replicate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5436
Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5437
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5437
Write Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5438
Write With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5438
Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5439
Read Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5440
Read With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5441
Messenger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5442
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5442
Write Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5443
Write With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5445
Write Ack. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5446
Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5447
Read Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5448
Read With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5449
Read Ack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5450
Read Ack With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5451
Accumulator Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5453
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5453
Write Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5453
Write With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5454
Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5455
Read Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5456
Read With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5457
Event Messenger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5458
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5458
Read Event Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5460
Read Multiple Event Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5461
High Speed Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5463
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5463
Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5465
Replicate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5466

© National Instruments 95
LabVIEW Programming Reference Manual

Lossy Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5467


Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5467
Write Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5468
Write With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5470
Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5472
Read Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5473
Read With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5474
One Element Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5476
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5476
Write Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5477
Write With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5479
Read. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5480
Read Scheduled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5482
Read With Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5483
Replicate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5485
Actor Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5486
Launch Root Actor VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5489
Launch Nested Actor VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5490
Read Caller Enqueuer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5492
Read Self Enqueuer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5493
Send Normal Stop VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5493
Send Emergency Stop VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5494
Send Normal or Emergency Stop VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5495
Read Autostop Nested Actor Count VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5496
Read Actor VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5496
Read Caller-To-Actor Enqueuer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5497
Read Error Report VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5497
Send Error Report VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5498
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5499
Send Batch VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5501
Time-Delayed Send Message VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5502
Address Message VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5504
Send Self-Addressed Message VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5505
Send Message And Wait For Response VI . . . . . . . . . . . . . . . . . . . . . . . 5506
Send Launch Nested Actor Msg VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5507
Message Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5509

96 ni.com
LabVIEW Programming Reference Manual

Obtain Message Queue VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5511


Read Enqueuer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5512
Read Dequeuer VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5512
Release Message Queue VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5513
Enqueue VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5514
Dequeue VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5515
Equals Not A Refnum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5516
Equals Not A Refnum VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5517
Init Actor Queues FOR TESTING ONLY VI . . . . . . . . . . . . . . . . . . . . . . . . 5518
Generate Custom Trace VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5519
Commonly Overridden Methods (Actor Framework) . . . . . . . . . . . . . . . . . . 5520
Actor:Actor Core [Protected] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5520
Message:Do . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5521
Reply Msg:Do Core [Protected] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5522
Message:Drop Message Core [Protected] . . . . . . . . . . . . . . . . . . . . . . . 5523
Actor:Handle Error [Protected] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5524
Actor:Handle Last Ack Core [Protected] . . . . . . . . . . . . . . . . . . . . . . . . 5525
Actor:Pre Launch Init [Protected] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5526
Actor:Stop Core [Protected] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5527
Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5528
Libraries & Executables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5529
Call Library Function Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5530
System Exec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5532
Run AppleScript Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5535
Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5536
Open Pipe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5537
Open System Command Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5538
Close Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5540
Read From Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5540
Write To Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5541
Source Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5542
SCC Open SCC Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5544
SCC Get Latest Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5545
SCC Check In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5547
SCC Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5549
SCC Close SCC Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5550

© National Instruments 97
LabVIEW Programming Reference Manual

SCC Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5551


SCC Remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5553
SCC File Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5554
SCC Undo Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5556
SCC File Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5558
SCC File History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5559
SCC Compare Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5560
SCC Compare VIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5563
SCC Not A Source Control Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5565
Port I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5566
Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5566
Read Form Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5568
Read All Form Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5570
Read Uploaded Files Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5571
Read Postdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5573
Read Request Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5574
Read All Request Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5575
NI Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5576
Get Auth Details for NI Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5577
Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5578
Read Service Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5579
Get Web Service Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5580
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5581
Set HTTP Response MIME Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5583
Set HTTP Response Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5584
Set HTTP Redirect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5585
Set HTTP Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5586
Write Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5588
Flush Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5589
Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5590
Escape HTTP URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5591
Unescape HTTP URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5591
PNG Data to LV Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5592
LV Image to PNG Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5594
Application Web Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5597
Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5598

98 ni.com
LabVIEW Programming Reference Manual

Set ESP Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5599


Set String ESP Variable VI . . . . . . . . . . . . . . . . . . . . . . . . . . . 5600
Set Many String ESP Variables VI . . . . . . . . . . . . . . . . . . . . . 5601
Set Boolean ESP Variable VI . . . . . . . . . . . . . . . . . . . . . . . . . 5602
Set Many Boolean ESP Variables VI . . . . . . . . . . . . . . . . . . 5604
Set Double ESP Variable VI . . . . . . . . . . . . . . . . . . . . . . . . . . 5605
Set Many Double ESP Variables VI . . . . . . . . . . . . . . . . . . . 5606
Set Integer ESP Variable VI . . . . . . . . . . . . . . . . . . . . . . . . . . 5608
Set Many Integer ESP Variables VI . . . . . . . . . . . . . . . . . . . . 5609
Render ESP Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5610
Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5611
Create Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5613
Check If Session Exists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5614
Get Session ID Cookie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5615
Destroy Session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5616
Read Session Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5617
Read All Session Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5619
Write Session Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5620
Write Single Session Variable VI . . . . . . . . . . . . . . . . . . . . . 5621
Write Many Session Variables VI . . . . . . . . . . . . . . . . . . . . . 5622
Write Boolean Session Variable VI . . . . . . . . . . . . . . . . . . . 5624
Write Many Boolean Session Variables VI . . . . . . . . . . . . . 5625
Write Double Session Variable VI . . . . . . . . . . . . . . . . . . . . 5627
Write Many Double Session Variables VI . . . . . . . . . . . . . . 5628
Write Integer Session Variable VI . . . . . . . . . . . . . . . . . . . . . 5630
Write Many Integer Session Variables VI . . . . . . . . . . . . . . 5631
Delete Session Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5633
Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5634
Encrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5634
Decrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5636
Get Auth Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5637
.NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5638
Constructor Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5640
Property Node (.NET) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5641
Invoke Node (.NET) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5643
Close Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5644

© National Instruments 99
LabVIEW Programming Reference Manual

To More Generic Class Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5645


To More Specific Class Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5646
.NET Object To Variant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5648
To .NET Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5648
Register Event Callback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5649
Unregister For Events Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5651
Static VI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5652
Input Device Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5653
Initialize Joystick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5655
Initialize Keyboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5655
Initialize Mouse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5656
Query Input Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5657
Acquire Input Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5659
joystickAcquire VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5659
keyboardAcquire VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5663
mouseAcquire VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5664
Close Input Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5666
closeJoystick VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5667
closeKeyboard VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5668
closeMouse VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5668
ActiveX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5669
Automation Open Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5670
Close Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5672
To Variant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5673
Variant To Data Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5673
Property Node (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5675
Invoke Node (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5676
Register Event Callback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5677
Unregister For Events Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5679
Static VI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5680
Windows Registry Access VIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5681
Open Registry Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5683
Create Registry Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5685
Query Registry Key Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5688
Enum Registry Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5689
Close Registry Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5691

100 ni.com
LabVIEW Programming Reference Manual

Delete Registry Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5691


Enum Registry Values Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5693
Read Registry Value Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5695
Read Registry Value Simple STR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5695
Read Registry Value Simple U32 VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5697
Write Registry Value Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5698
Write Registry Value Simple STR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5699
Write Registry Value Simple U32 VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5700
Delete Registry Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5702
Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5702
Open Python Session Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5703
Python Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5704
Close Python Session Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5707
Close Reference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5707
MATLAB(R) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5708
Open MATLAB Session Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5709
Call MATLAB Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5709
Close MATLAB Session Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5711
Control & Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5712
PID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5712
PID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5715
PID (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5716
PID (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5719
PID (Compatibility) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5722
PID Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5726
PID Advanced (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5727
PID Advanced (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5732
PID Advanced Autotuning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5737
PID Autotuning (Temperature) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5742
PID Autotuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5747
PID Gain Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5752
PID Gain Schedule (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5753
PID Gain Schedule (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5755
PID Structure Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5757
PID Structure Conversion (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5759
PID Structure Conversion (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . 5762

© National Instruments 101


LabVIEW Programming Reference Manual

PID Autotuning Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5765


PID Autotuning Design (Auto) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5765
PID Autotuning Design (Ziegler-Nichols) VI . . . . . . . . . . . . . . . . . . . . . 5768
PID Autotuning Design (Cohen-Coon) VI . . . . . . . . . . . . . . . . . . . . . . . . 5771
PID Autotuning Design (Chien-Hrones-Reswick) VI . . . . . . . . . . . . . . 5773
PID Autotuning Design (Internal Model Control) VI. . . . . . . . . . . . . . . 5776
PID Online Autotuning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5778
PID Online Autotuning (Step Open Loop) VI . . . . . . . . . . . . . . . . . . . . . 5779
PID Online Autotuning (Step Closed Loop) VI . . . . . . . . . . . . . . . . . . . 5783
PID Online Autotuning (Relay Feedback) VI . . . . . . . . . . . . . . . . . . . . . 5787
PID Online Autotuning (PID on the loop) VI . . . . . . . . . . . . . . . . . . . . . 5791
PID Lead-Lag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5795
PID Lead-Lag (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5796
PID Lead-Lag (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5798
PID Setpoint Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5801
PID Control Input Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5802
PID Control Input Filter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5804
PID Control Input Filter (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 5805
PID Output Rate Limiter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5806
PID Output Rate Limiter (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5807
PID Output Rate Limiter (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . 5809
PID EGU to Percentage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5811
PID EGU to Percentage (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5812
PID EGU to Percentage (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 5813
PID Percentage to EGU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5814
PID Percentage to EGU (DBL) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5815
PID Percentage to EGU (DBL Array) VI . . . . . . . . . . . . . . . . . . . . . . . . . . 5817
Fuzzy Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5818
FL Fuzzy Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5820
FL Fuzzy Controller (SISO) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5820
FL Fuzzy Controller (SIMO) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5822
FL Fuzzy Controller (MISO) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5823
FL Fuzzy Controller (MIMO) VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5825
FL Save Fuzzy System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5826
FL Load Fuzzy System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5827
FL New Fuzzy System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5828

102 ni.com
LabVIEW Programming Reference Manual

Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5834
FL Create Variable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5835
FL Get Variable VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5838
FL Set Variable VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5840
FL Get Number of Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5843
FL Get Variable Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5844
FL Plot Variable VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5844
Membership. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5846
FL Create Membership Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5847
FL Create Membership Function (Triangle) VI . . . . . . . . . . . . . . 5848
FL Create Membership Function (Trapezoid) VI . . . . . . . . . . . . . 5850
FL Create Membership Function (Singleton) VI . . . . . . . . . . . . . 5852
FL Create Membership Function (Sigmoid) VI . . . . . . . . . . . . . . 5854
FL Create Membership Function (Gaussian) VI . . . . . . . . . . . . . 5857
FL Create Membership Function (User-Defined) VI . . . . . . . . . . 5859
FL Get Membership Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5862
FL Get Membership Function (Fuzzy System) VI . . . . . . . . . . . . 5863
FL Get Membership Function (MF Array) VI . . . . . . . . . . . . . . . . . 5865
FL Set Membership Function VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5869
FL Set Membership Function (Fuzzy System) VI . . . . . . . . . . . . 5869
FL Set Membership Function (MF array) VI . . . . . . . . . . . . . . . . . 5872
FL Get Number of Membership Functions . . . . . . . . . . . . . . . . . . . . . . 5876
FL Get Membership Function Names VI. . . . . . . . . . . . . . . . . . . . . . . . . 5877
FL Get Membership Function Names (Fuzzy System) VI . . . . . 5877
FL Get Membership Function Names (MF Array) VI . . . . . . . . . . 5879
Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5881
FL Create Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5883
FL Get Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5887
FL Set Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5890
FL Get Number of Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5892
FL Get Rules as Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5893
FL Create Antecedent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5894
FL Create Consequent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5896
FL Integrate Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5897
FL System VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5901
Express . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5906

© National Instruments 103


LabVIEW Programming Reference Manual

Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5907
Instrument Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5908
Simulate Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5909
Simulate Arbitrary Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5917
Acquire Sound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5919
Read From Measurement File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5921
Prompt User for Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5926
File Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5928
Signal Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5932
Spectral Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5933
Distortion Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5939
Tone Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5942
Dual Channel Spectral Measurement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5944
Amplitude and Level Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5951
Timing and Transition Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5955
Curve Fitting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5958
Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5963
Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5968
Convolution and Correlation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5974
Simulate Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5976
Mask and Limit Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5983
Create Histogram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5987
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5989
Instrument Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5990
Build Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5991
Display Message to User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5994
Play Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5996
Write To Measurement File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5997
Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6005
Signal Manipulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6008
Merge Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6010
Split Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6011
Select Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6012
............................................................ 6013
Align and Resample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6014
Collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6018

104 ni.com
LabVIEW Programming Reference Manual

............................................................ 6019
Sample Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6019
............................................................ 6023
Trigger and Gate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6024
Relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6028
............................................................ 6030
Append Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6030
............................................................ 6033
Repack Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6033
............................................................ 6035
Extract Portion of Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6035
............................................................ 6037
Delay Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6038
............................................................ 6039
Convert from Dynamic Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6040
............................................................ 6041
Convert to Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6042
............................................................ 6043
Group Digital Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6044
Set Dynamic Data Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6046
Get Dynamic Data Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6048
Execution Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6051
While Loop with Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6052
Flat Sequence Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6052
Case Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6054
Time Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6056
Elapsed Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6056
Arithmetic & Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6059
Formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6060
Scaling and Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6064
Time Domain Math. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6066
Express Numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6068
Add Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6071
Subtract Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6072
Multiply Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6074
Divide Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6075

© National Instruments 105


LabVIEW Programming Reference Manual

Increment Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6076


Decrement Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6077
Compound Arithmetic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6078
Absolute Value Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6080
Round To Nearest Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6081
Round Toward -Infinity Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6082
Round Toward +Infinity Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6082
Scale By Power Of 2 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6083
Square Root Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6084
Square Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6086
Negate Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6087
Reciprocal Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6087
Sign Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6088
Numeric Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6089
Random Number (0-1) Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6090
Positive Infinity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6090
Negative Infinity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6090
Machine Epsilon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6091
Express Math & Scientific Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . 6091
Pi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6092
Pi Multiplied By 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6092
Pi Divided By 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6092
Reciprocal Of Pi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6092
Natural Logarithm Of Pi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6093
Natural Logarithm Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6093
Reciprocal Of e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6093
Base 10 Logarithm Of e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6093
Natural Logarithm Of 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6094
Natural Logarithm Of 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6094
Planck's Constant (J/Hz) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6094
Elementary Charge (C) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6094
Speed Of Light In Vacuum (m/sec) . . . . . . . . . . . . . . . . . . . . . . . . 6094
Gravitational Constant (N m2/kg2) . . . . . . . . . . . . . . . . . . . . . . . . 6095
Avogadro Constant (1/mol) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6095
Rydberg Constant (1/m) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6095
Molar Gas Constant (J/(mol K)) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6095

106 ni.com
LabVIEW Programming Reference Manual

Express Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6095


Express Trigonometric Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6096
Sine Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6097
Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6098
Tangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6099
Secant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6100
Cosecant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6100
Cotangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6101
Inverse Sine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6102
Inverse Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6103
Inverse Tangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6103
Inverse Secant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6104
Inverse Cosecant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6105
Inverse Cotangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6106
Sine & Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6106
Sinc Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6107
Inverse Tangent (2 Input) Function . . . . . . . . . . . . . . . . . . . . . . . 6108
Express Exponential Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6109
Exponential Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6110
Exponential (Arg) -1 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6111
Power Of 10 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6112
Power Of 2 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6113
Power Of X Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6113
Y-th Root of X Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6114
Natural Logarithm Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6115
Natural Logarithm (Arg +1) Function . . . . . . . . . . . . . . . . . . . . . . 6117
Logarithm Base 10 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6117
Logarithm Base 2 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6118
Logarithm Base X Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6119
Express Hyperbolic Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6120
Hyperbolic Sine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6121
Hyperbolic Cosine Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6121
Hyperbolic Tangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6122
Hyperbolic Secant Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6123
Hyperbolic Cosecant Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 6124
Hyperbolic Cotangent Function . . . . . . . . . . . . . . . . . . . . . . . . . . 6124

© National Instruments 107


LabVIEW Programming Reference Manual

Inverse Hyperbolic Sine Function . . . . . . . . . . . . . . . . . . . . . . . . . 6125


Inverse Hyperbolic Cosine Function . . . . . . . . . . . . . . . . . . . . . . 6126
Inverse Hyperbolic Tangent Function . . . . . . . . . . . . . . . . . . . . . 6127
Inverse Hyperbolic Secant Function . . . . . . . . . . . . . . . . . . . . . . 6127
Inverse Hyperbolic Cosecant Function . . . . . . . . . . . . . . . . . . . . 6128
Inverse Hyperbolic Cotangent Function . . . . . . . . . . . . . . . . . . . 6129
Express Boolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6129
And Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6131
Or Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6132
Exclusive Or Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6133
Not Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6134
Not And Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6135
Not Or Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6137
Not Exclusive Or Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6138
Implies Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6139
True Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6140
False Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6141
Express Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6141
Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6143
Not Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6144
Greater? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6146
Less? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6146
Greater Or Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6147
Less Or Equal? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6148
Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6149
Not Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6149
Greater Than 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6150
Less Than 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6150
Greater Or Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6151
Less Or Equal To 0? Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6151
Select Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6152
Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6152
Build XY Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6158
................................................................. 6159
Build Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6159
................................................................. 6161

108 ni.com
LabVIEW Programming Reference Manual

Addons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6162
Find LabVIEW Add-ons... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6163
Toolkits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6163
Favorites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6164
User Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6164
Express User Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6164
Property and Method Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6165
LabVIEW 3D Graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6165
LabVIEW 3D Graph Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6165
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6172
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6172
Graph:View Direction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6173
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6173
Graph:3d Picture Control Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6174
Graph:X-Y Grid Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6175
Graph:Y-Z Grid Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6175
Graph:X-Z Grid Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6176
Graph:Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6176
Graph:Disable Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6177
Plots:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6177
Plots:Draw XY Projection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6178
Plots:Draw YZ Projection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6178
Plots:Draw XZ Projection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6179
Plots:Surface Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6179
Plots:Surface Color Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6180
Plots:Surface Opacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6181
Plots:Surface Shading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6181
Plots:Contour Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6182
Plots:Contour Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6182
Plots:Contour Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6183
Plots:Contour Antialiasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6183
Plots:Contour Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6184
Plots:Contour Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6184
Plots:Contour Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6185
Plots:Contour Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6185
Plots:Contour Level List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6186

© National Instruments 109


LabVIEW Programming Reference Manual

Plots:Contour Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6187


Plots:Contour Anchored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6187
Plots:Contour Anchor Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6188
Plots:Normal Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6188
Plots:Normal Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6189
Plots:Normal Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6189
Plots:Normal Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6190
Plots:Normal Antialiasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6190
Plots:Overlay Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6191
Plots:Overlay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6191
Plots:Overlay Antialiasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6192
Plots:Overlay Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6193
Plots:Overlay Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6193
Plots:Overlay Point Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6194
Plots:Overlay Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6194
Plots:Surface Shininess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6195
Plots:Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6195
Axes:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6196
Axes:Caption Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6196
Axes:Caption Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6197
Axes:Caption Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6197
Axes:Caption Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6198
Axes:Grid Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6198
Axes:Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6199
Axes:Major Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6200
Axes:Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6200
Axes:Major Tick Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6201
Axes:Minor Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6201
Axes:Minor Tick Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6202
Axes:Label Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6202
Axes:Label Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6203
Axes:Label Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6203
Axes:Range Autoscale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6204
Axes:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6204
Axes:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6205
Axes:Label Opposite Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6206

110 ni.com
LabVIEW Programming Reference Manual

Axes:Caption Opposite Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6206


Value Pairs:X Value Pairs Data Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6207
Value Pairs:X Value Pairs Show Ticks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6207
Value Pairs:X Value Pairs Show Grid Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . 6208
Value Pairs:X Value Pairs Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6208
Value Pairs:Y Value Pairs Data Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6209
Value Pairs:Y Value Pairs Show Ticks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6209
Value Pairs:Y Value Pairs Show Grid Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6210
Value Pairs:Y Value Pairs Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6211
Value Pairs:Z Value Pairs Data Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6211
Value Pairs:Z Value Pairs Show Ticks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6212
Value Pairs:Z Value Pairs Show Grid Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . 6212
Value Pairs:Z Value Pairs Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6213
Format:X Axis Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6213
Format:Y Axis Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6214
Format:Z Axis Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6214
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6215
Cursors:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6215
Cursors:Cursor Enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6216
Cursors:Cursor Point Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6217
Cursors:Cursor Point Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6217
Cursors:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6218
Cursors:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6218
Cursors:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6219
Cursors:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6219
Cursors:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6220
Cursors:Cursor Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6220
Cursors:Cursor Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6221
Cursors:Cursor Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6221
Cursors:Cursor Line Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6222
Cursors:Cursor Line Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6222
Cursors:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6223
Cursors:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6224
Cursors:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6224
Cursors:Cursor Plane XY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6225
Cursors:Cursor Plane YZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6225

© National Instruments 111


LabVIEW Programming Reference Manual

Cursors:Cursor Plane XZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6226


Cursors:Cursor Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6226
Cursors:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6227
Cursors:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6227
Cursors:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6228
Cursors:Cursor Text Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6228
Cursors:Cursor Text Opacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6229
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6230
Lights:Brightness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6230
Lights:Focus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6231
Lights:Linear Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6231
Lights: Quadratic Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6232
Lights:Light Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6232
ActiveX Properties and Methods for LabVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6233
Application Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6233
Application Methods (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6233
AllMethodsOfLVClass2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6236
BringToFront . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6237
BrowseDataSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6237
CreateLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6237
CreateLVClassInterfaceLibrary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6238
GetHierImgScaled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6238
GetVIEditorVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6240
_GetVIQualifiedName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6241
GetVIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6242
GetVIVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6244
LibraryGetFileLVVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6244
LVClassImplementingVIPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6245
MassCompile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6245
NewProject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6246
OpenLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6246
OpenProject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6247
ProjectGetFileLVVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6247
Quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6248
Application Properties (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6248
AllProjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6256

112 ni.com
LabVIEW Programming Reference Manual

AllVIsInMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6256
AppKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6256
ApplicationDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6257
AppName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6257
AppTargetCPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6258
AppTargetOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6258
AutomaticClose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6258
CmdArgs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6259
DefaultDataLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6259
ExportedVIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6260
Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6260
OSBuildNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6260
OSDetailedName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6261
OSName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6261
OSVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6262
PrintDefaultPrinter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6262
PrintersAvailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6262
PrintingColorDepth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6263
PrintMethod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6263
PrintSetupCustomClusterConstants . . . . . . . . . . . . . . . . . . . . . . . . . . . 6263
PrintSetupCustomConnector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6264
PrintSetupCustomControlDesc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6264
PrintSetupCustomControls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6264
PrintSetupCustomControlTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6265
PrintSetupCustomDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6265
PrintSetupCustomDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6265
PrintSetupCustomDiagramHidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6266
PrintSetupCustomDiagramRepeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6266
PrintSetupCustomExpressVIConfigInfo . . . . . . . . . . . . . . . . . . . . . . . . . 6266
PrintSetupCustomHierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6267
PrintSetupCustomHistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6267
PrintSetupCustomLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6267
PrintSetupCustomPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6268
PrintSetupCustomPanelBorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6268
PrintSetupCustomSubVIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6268
PrintSetupFileWrapText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6269

© National Instruments 113


LabVIEW Programming Reference Manual

PrintSetupJPEGQuality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6269
PrintSetupPNGCompressLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6270
RTHostConnected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6270
SaveVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6270
SaveVersions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6271
ShowFPTipStrips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6271
UserName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6272
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6272
VersionYear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6272
VIServerPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6273
Enumerations (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6273
AppKindEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6273
AppTargCPUEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6274
AppTargOSEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6274
ExecStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6275
FPRunTimePosEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6275
FPStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6276
HTMLImageFormatEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6276
LibraryItemScopeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6277
PageOrientationEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6277
PrintFormatEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6277
PrintMarginsEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6278
PrintMethodsEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6278
PrintSetupCustomLabelEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6279
VIExecSysEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6279
VIFPBehaviorEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6280
VILockStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6280
VIPriorityEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6281
VITypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6281
Project Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6282
Project Methods (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6282
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6283
CloseWindow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6283
DeployItems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6283
OpenWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6284
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6284

114 ni.com
LabVIEW Programming Reference Manual

SaveForPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6285
Project Properties (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6285
ActiveItemsInTree. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6287
Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6287
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6288
MyComputer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6288
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6288
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6289
Root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6289
SelectedItemsInTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6289
Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6290
WindowState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6290
ProjectItem Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6290
ProjectItem Methods (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6290
AddFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6292
AddItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6292
AddItemFromMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6293
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6294
DeleteTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6294
GetAllDescendents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6295
GetTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6296
GetTagNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6296
GetXMLTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6297
SetTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6297
SetXMLTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6298
ProjectItem Properties (ActiveX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6298
Children . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6302
ContainsConflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6302
DisplayName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6303
FindCallers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6303
FindChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6303
FindConflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6304
FindFriends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6304
FindItemsIncorrectlyClaimedByLibrary . . . . . . . . . . . . . . . . . . . . . . . . 6304
FindItemsThatMakeThisADependency . . . . . . . . . . . . . . . . . . . . . . . . . 6305
FindItemsWithNoCallers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6305

© National Instruments 115


LabVIEW Programming Reference Manual

FindSubVIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6305
FindVariableCallers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6306
Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6306
InConflict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6306
ItemID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6307
LibraryItemType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6307
LibraryItemTypeString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6307
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6308
Parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6308
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6309
Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6309
Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6309
TypeGUID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6310
TypeString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6310
VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6310
VINoLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6311
VisibleInTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6311
Library Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6311
Library Methods (ActiveX). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6312
DeleteLibTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6313
DisconnectFromLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6314
GetLibTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6314
GetLockState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6315
GetSourceScope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6316
GetTagNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6316
HiliteInProjectWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6317
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6317
SaveCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6318
SaveForPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6318
SetLibTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6319
SetLockState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6320
SetSourceScope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6320
SetSourceScopeAndPropagate . . . . . . . . . . . . . . . . . . . . . . . . . . . 6321
Library Properties (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6322
AlarmsEventsDBComputer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6324
AlarmsEventsDBName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6325

116 ni.com
LabVIEW Programming Reference Manual

AlarmsEventsDBPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6325
AlarmsEventsEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6325
AlarmsEventsUseDataLoggingDB . . . . . . . . . . . . . . . . . . . . . . . . . 6326
ContainsCompiledCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6326
DataLoggingDBComputer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6326
DataLoggingDBName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6327
DataLoggingDBPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6327
DataLoggingEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6327
DataLoggingLifespan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6328
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6328
HelpDocumentPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6329
HelpDocumentTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6329
LocalName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6330
QualifiedName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6330
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6331
XInterfaceLibrary Properties and Methods . . . . . . . . . . . . . . . . . . . . . . 6331
XInterfaceLibrary Methods (ActiveX) . . . . . . . . . . . . . . . . . . . . . . 6331
AddAbility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6332
AddMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6332
NewProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6333
PropertyFolder Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6333
PropertyFolder Methods (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6333
AddPropertyVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6334
XPropertyFolder Properties and Methods . . . . . . . . . . . . . . . . . . . . . . 6334
XPropertyFolder Properties (ActiveX) . . . . . . . . . . . . . . . . . . . . . 6334
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6335
HelpTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6335
Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6336
LongName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6336
TargetItem Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6336
TargetItem Methods (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6336
RefreshDependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6337
TargetItem Properties (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6337
BuildSpecifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6337
Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6338
VI Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6338

© National Instruments 117


LabVIEW Programming Reference Manual

VI Methods (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6338


Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6343
Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6343
Call2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6344
CenterFrontPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6345
CloseFrontPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6345
DisconnectFromLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6345
ExportVIStrings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6346
FPGetRuntimePos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6347
FPRunTimePosRunCentered . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6348
FPRunTimePosRunCustom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6348
FPRunTimePosRunMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6350
FPRunTimePosRunMin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6350
FPRunTimePosRunUnchanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6351
GetControlValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6351
GetLockState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6352
GetVIDependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6352
ImportVIStrings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6355
MakeCurValueDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6356
OpenFrontPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6356
PrintPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6357
PrintVIToHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6357
PrintVIToPrinter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6358
PrintVIToRTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6359
PrintVIToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6361
ReinitializeAllToDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6361
Revert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6362
Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6362
SaveForPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6363
SaveInstrument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6363
SaveRunTimeMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6364
SetControlValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6364
SetLockState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6365
SetVIIcon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6365
VI Properties (ActiveX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6366
AllowDebugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6377

118 ni.com
LabVIEW Programming Reference Manual

BDModificationBitSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6377
BDSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6378
Callers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6378
CloneName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6378
CloseFPAfterCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6379
CodeSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6379
DataSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6379
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6379
EditMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6380
ExecInlining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6380
ExecIsInlineable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6381
ExecPriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6381
ExecState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6381
ExpandWhenDroppedAsSubVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6381
FPAllowRTPopup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6382
FPBehavior. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6382
FPHiliteReturnButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6382
FPKeepWinProps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6383
FPMinimizable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6383
FPModificationBitSet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6384
FPMonitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6384
FPResizable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6384
FPRunTransparently . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6385
FPShowMenuBar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6385
FPSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6385
FPState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6386
FPTitleBarVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6386
FPTransparency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6387
FPWinBounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6387
FPWinClosable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6388
FPWinCustomTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6388
FPWinIsFrontMost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6389
FPWinPanelBounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6389
FPWinTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6390
HelpDocumentPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6390
HelpDocumentTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6391

© National Instruments 119


LabVIEW Programming Reference Manual

HelpDocumentUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6391
HelpUseOnline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6392
HistAddCommentsAtSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6392
HistoryText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6392
HistPromptAtClose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6393
HistPromptForCommentsAtSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6393
HistRecordAppComments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6393
HistUseDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6394
IsCloneVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6394
IsProbe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6395
IsReentrant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6395
Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6395
LogAtFinish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6396
LogFilePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6396
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6396
OwningApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6397
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6397
PreferredExecSystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6397
PrintHeaderDatePrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6398
PrintHeaderModifyDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6398
PrintHeaderPageNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6398
PrintHeaderVIIcon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6399
PrintHeaderVIName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6399
PrintingBDScaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6399
PrintingFPScaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6400
PrintingHeaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6400
PrintingHeaderVIPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6401
PrintingOrientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6401
PrintLogFileAtFinish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6401
PrintMargins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6401
ReentrancyType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6402
RevisionNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6402
RunOnOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6403
RunTimeMenuPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6403
ShowFPOnCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6403
ShowFPOnLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6404

120 ni.com
LabVIEW Programming Reference Manual

SuspendOnCall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6404
TBShowAbortButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6404
TBShowFreeRunButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6405
TBShowRunButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6405
TBVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6405
VIType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6406
DataSocket Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6407
Buffer Maximum Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6407
Buffer Maximum Packets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6407
Buffer Utilization (Bytes). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6408
Buffer Utilization (Packets) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6408
Connection Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6409
URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6409
Filesystem Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6409
Filesystem Statistics Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6409
Get Bytes Free VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6410
Get Bytes Total VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6410
Is Read Only VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6411
LabVIEW Manager Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6412
File Manager Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6412
FAddPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6415
FAppendName (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . 6416
FAppPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6416
FArrToPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6417
FCopy (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6418
FCreate (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6419
FCreateAlways (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6421
FDepth (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6423
FDestroyPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . 6424
FDirName (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6424
FDisposeRefNum (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . 6425
FEmptyPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6426
FExists (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6427
FFlattenPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . 6427
FFlush (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6428
FGetAccessRights (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . 6429

© National Instruments 121


LabVIEW Programming Reference Manual

FGetDefGroup (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6429


FGetEOF (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6430
FGetInfo (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6431
FGetPathType (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6432
FGetVolInfo (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6433
FIsAPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6434
FIsAPathOfType (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . 6435
FIsAPathOrNotAPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . 6436
FIsARefNum (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6436
FIsEmptyPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6437
FListDir (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6437
FLockOrUnlockRange (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . 6439
FMakePath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6440
FMClose (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6441
FMOpen (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6442
FMove (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6444
FMRead (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6445
FMSeek (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6446
FMTell (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6447
FMWrite (LabVIEW Manager Function). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6448
FName (LabVIEW Manager Function). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6449
FNamePtr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6450
FNewDir (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6451
FNewRefNum (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6451
FNotAPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6452
FPathCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6453
FPathCpy (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6454
FPathToArr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6454
FPathToAZString (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . 6455
FPathToDSString (LabVIEW Manager Function). . . . . . . . . . . . . . . . . . . . . . . 6456
FPathToPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . 6457
FRefNumToFD (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6458
FRefNumToPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . 6459
FRelPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6459
FRemove (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6460
FSetAccessRights (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . 6461

122 ni.com
LabVIEW Programming Reference Manual

FSetEOF (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6462


FSetInfo (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6463
FSetPathType (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6465
FStrFitsPat (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6465
FStringToPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6466
FTextToPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6467
FUnFlattenPath (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . 6468
FVolName (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6469
Permissions for Files and Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6469
Memory Manager Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6470
ClearMem (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6471
DSCheckHandle (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . 6472
DSCheckPtr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6472
DSCopyHandle (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . 6473
DSDisposeHandle (LabVIEW Manager Function). . . . . . . . . . . . . . . . . . . . . . 6474
DSDisposePtr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6474
DSGetHandleSize (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . 6475
DSHeapCheck (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6476
DSMaxMem (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6476
DSMemStats (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . 6477
DSNewAlignedHandle (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . 6478
DSNewAlignedHClr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . 6481
DSNewHandle (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6483
DSNewHClr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6484
DSNewPClr (LabVIEW Manager Function). . . . . . . . . . . . . . . . . . . . . . . . . . . . 6484
DSNewPtr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6485
DSRecoverHandle (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . 6485
DSSetAlignedHandleSize (LabVIEW Manager Function) . . . . . . . . . . . . . . . 6486
DSSetAlignedHSzClr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . 6489
DSSetHandleSize (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . 6492
DSSetHSzClr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . 6493
MoveBlock (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6493
NumericArrayResize (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . 6494
SwapBlock (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6495
Support Manager Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6496
Abs (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6499

© National Instruments 123


LabVIEW Programming Reference Manual

ASCIITime (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6499


BinSearch (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6500
BlockCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6501
Cat4Chrs (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6501
CPStrBuf (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6502
CPStrCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6503
CPStrIndex (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6503
CPStrInsert (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6504
CPStrLen (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6505
CPStrRemove (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6505
CPStrReplace (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . 6506
CPStrSize (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6506
CToPStr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6507
DateCString (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6507
DateToSecs (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6508
FileNameCmp (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6509
FileNameIndCmp (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . 6510
FileNameNCmp (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . 6510
GetALong (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6511
HexChar (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6511
Hi16 (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6512
HiByte (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6512
HiNibble (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6513
IsAlpha (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6513
IsDigit (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6514
IsLower (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6514
IsUpper (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6515
Lo16 (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6516
LoByte (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6516
Long (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6517
LoNibble (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6517
LStrBuf (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6517
LStrCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6518
LStrLen (LabVIEW Manager Macro). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6519
LToCStrN (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6519
LToPStr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6520

124 ni.com
LabVIEW Programming Reference Manual

Mathematical Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6520


Max (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6522
MilliSecs (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6522
Min (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6522
NIGetOneErrorCode (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . 6523
Occur (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6523
Offset (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6524
Pin (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6525
PostLVUserEvent (LabVIEW Manager Function). . . . . . . . . . . . . . . . . . . . . . . 6525
PPStrCaseCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . 6526
PPStrCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6526
Printf (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6527
PStrBuf (LabVIEW Manager Macro). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6531
PStrCaseCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6531
PStrCat (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6532
PStrCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6532
PStrCpy (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6533
PStrLen (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6534
PStrNCpy (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6534
PToCStr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6535
PToLStr (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6535
QSort (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6536
RandomGen (LabVIEW Manager Function). . . . . . . . . . . . . . . . . . . . . . . . . . . 6536
SecsToDate (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6537
SetALong (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6537
StrCat (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6538
StrCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6538
StrCpy (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6539
StrLen (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6540
StrNCaseCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . 6540
StrNCmp (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6541
StrNCpy (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6541
TimeCString (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6542
TimeInSecs (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . 6543
ToLower (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6543
ToUpper (LabVIEW Manager Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6543

© National Instruments 125


LabVIEW Programming Reference Manual

Unused (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6544


Word (LabVIEW Manager Macro) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6544
Math Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6545
2D Graphs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6545
2D Compass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6545
2D Compass Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6545
Graph:Graph Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6549
Graph:Plot Legend Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6550
Graph:Plot Legend Auto Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6551
Graph:Plot Legend Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6551
Graph:X Scrollbar Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6552
Graph:Scale Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6552
Graph:Cursor Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6553
Graph:Plot FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6553
Graph:Plot BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6554
Graph:Bounds Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6554
Graph:Bounds Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6555
Format:R Scale Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6556
R Scale:Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6556
R Scale:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6557
R Scale:Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6557
R Scale:Scale Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6558
R Scale:Tick:Major Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6558
R Scale:Tick:Minor Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6559
R Scale:Grid:Major Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6559
R Scale:Grid:Minor Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6560
R Scale:Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6561
R Scale:Range:Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6561
R Scale:Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6562
R Scale:Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . . . 6562
R Scale:Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6563
R Scale:Marker:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6563
R Scale:Marker:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6564
R Scale:Marker:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6564
R Scale:Marker:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6565
R Scale:Marker:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6566

126 ni.com
LabVIEW Programming Reference Manual

R Scale:Marker:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6566


R Scale:Marker:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6567
R Scale:Marker:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6567
R Scale:Marker:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . 6568
R Scale:Name Label:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6568
R Scale:Name Label:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6569
R Scale:Name Label:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6569
R Scale:Name Label:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6570
R Scale:Name Label:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6571
R Scale:Name Label:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . 6571
R Scale:Name Label:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . 6572
R Scale:Name Label:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . 6572
R Scale:Name Label:Font Underline . . . . . . . . . . . . . . . . . . . . . . 6573
R Scale:Name Label:Justification . . . . . . . . . . . . . . . . . . . . . . . . . 6573
R Scale:Name Label:Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6574
Cursor:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6574
Cursor:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6575
Cursor:Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6576
Cursor:Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6576
Cursor:Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6577
Cursor:Name Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6577
Cursor:Allow Drag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6578
Cursor:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6578
Cursor:Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6579
Cursor:Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6579
Cursor:Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6580
Cursor:X Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6581
Cursor:Y Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6581
Cursor:Watch Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6582
Cursor:Watch All Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6582
Cursor:Plot Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6583
Cursor:Label Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6583
Cursor:Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6584
Cursor:Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6585
Cursor:Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6585
Cursor:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6586

© National Instruments 127


LabVIEW Programming Reference Manual

Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6586


Plot Specific:Compass Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6587
Plot Specific:Compass Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6587
Plot Specific:Compass Line Style . . . . . . . . . . . . . . . . . . . . . . . . . 6588
Plot Specific:Compass Line Width . . . . . . . . . . . . . . . . . . . . . . . . 6588
Plot Specific:Compass Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6589
Plot Specific:Show Phase Scale . . . . . . . . . . . . . . . . . . . . . . . . . . 6590
Annotation List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6590
2D Compass Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6591
Export Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6591
2D Error Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6592
2D Error Bar Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6592
Graph:Graph Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6598
Graph:Plot Legend Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6599
Graph:Plot Legend Auto Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6600
Graph:Plot Legend Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6600
Graph:X Scrollbar Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6601
Graph:Scale Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6601
Graph:Cursor Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6602
Graph:Plot FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6602
Graph:Plot BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6603
Graph:Bounds Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6603
Graph:Bounds Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6604
Format:X Scale Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6605
Format:Y Scale Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6605
X Scale:Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6606
X Scale:Flipped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6606
X Scale:Mapping Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6607
X Scale:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6607
X Scale:Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6608
X Scale:Scale Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6608
X Scale:Offset and Multiplier:Offset . . . . . . . . . . . . . . . . . . . . . . . 6609
X Scale:Offset and Multiplier:Multiplier . . . . . . . . . . . . . . . . . . . . 6610
X Scale:Tick:Major Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6610
X Scale:Tick:Minor Tick Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6611
X Scale:Grid:Major Grid Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6611

128 ni.com
LabVIEW Programming Reference Manual

X Scale:Grid:Minor Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6612


X Scale:Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6612
X Scale:Range:Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6613
X Scale:Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6613
X Scale:Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . . . 6614
X Scale:Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6615
X Scale:Marker:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6615
X Scale:Marker:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6616
X Scale:Marker:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6616
X Scale:Marker:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6617
X Scale:Marker:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6617
X Scale:Marker:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6618
X Scale:Marker:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6618
X Scale:Marker:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6619
X Scale:Marker:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . 6620
X Scale:Name Label:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6620
X Scale:Name Label:FG Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6621
X Scale:Name Label:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6621
X Scale:Name Label:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6622
X Scale:Name Label:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6622
X Scale:Name Label:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . 6623
X Scale:Name Label:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . 6623
X Scale:Name Label:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . 6624
X Scale:Name Label:Font Underline . . . . . . . . . . . . . . . . . . . . . . . 6625
X Scale:Name Label:Justification . . . . . . . . . . . . . . . . . . . . . . . . . 6625
X Scale:Name Label:Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6626
Y Scale:Editable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6626
Y Scale:Filpped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6627
Y Scale:Mapping Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6627
Y Scale:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6628
Y Scale:Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6628
Y Scale:Scale Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6629
Y Scale:Offset and Multiplier:Offset . . . . . . . . . . . . . . . . . . . . . . . 6630
Y Scale:Offset and Multiplier:Multiplier . . . . . . . . . . . . . . . . . . . . 6630
Y Scale:Tick:Major Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6631
Y Scale:Tick:Minor Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6631

© National Instruments 129


LabVIEW Programming Reference Manual

Y Scale:Grid:Major Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6632


Y Scale:Grid:Minor Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6632
Y Scale:Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6633
Y Scale:Range:Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6633
Y Scale:Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6634
Y Scale:Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . . . 6635
Y Scale:Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6635
Y Scale:Marker:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6636
Y Scale:Marker:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6636
Y Scale:Marker:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6637
Y Scale:Marker:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6637
Y Scale:Marker:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6638
Y Scale:Marker:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6638
Y Scale:Marker:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6639
Y Scale:Marker:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6640
Y Scale:Marker:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . 6640
Y Scale:Name Label:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6641
Y Scale:Name Label:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6641
Y Scale:Name Label:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6642
Y Scale:Name Label:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6642
Y Scale:Name Label:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6643
Y Scale:Name Label:Font Bold. . . . . . . . . . . . . . . . . . . . . . . . . . . . 6643
Y Scale:Name Label:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . 6644
Y Scale:Name Label:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . 6645
Y Scale:Name Label:Font Underline . . . . . . . . . . . . . . . . . . . . . . . 6645
Y Scale:Name Label:Justification . . . . . . . . . . . . . . . . . . . . . . . . . 6646
Y Scale:Name Label:Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6646
Cursor:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6647
Cursor:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6647
Cursor:Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6648
Cursor:Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6648
Cursor:Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6649
Cursor:Name Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6650
Cursor:Allow Drag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6650
Cursor:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6651
Cursor:Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6651

130 ni.com
LabVIEW Programming Reference Manual

Cursor:Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6652
Cursor:Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6652
Cursor:X Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6653
Cursor:Y Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6653
Cursor:Watch Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6654
Cursor:Watch All Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6655
Cursor:Plot Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6655
Cursor:Label Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6656
Cursor:Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6656
Cursor:Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6657
Cursor:Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6657
Cursor:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6658
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6658
Plot Specific:Error Bar Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6659
Plot Specific:Error Bar Line Style . . . . . . . . . . . . . . . . . . . . . . . . . 6660
Plot Specific:Error Bar Line Width. . . . . . . . . . . . . . . . . . . . . . . . . 6660
Plot Specific:Error Bar Point Style . . . . . . . . . . . . . . . . . . . . . . . . 6661
Plot Specific:Error Bar Interpolation . . . . . . . . . . . . . . . . . . . . . . 6661
Plot Specific:Error Bar Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6662
Plot Specific:Error Bar Point Fill Color . . . . . . . . . . . . . . . . . . . . . 6662
Plot Specific:Error Bar Fill to . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6663
Plot Specific:Error Bar Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6663
Plot Specific:Marker Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . 6664
Plot Specific:Marker Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . 6665
Plot Specific:Marker Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6665
Plot Specific:Error Bar Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6666
Annotation List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6666
2D Error Bar Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6667
Export Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6667
2D Feather . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6668
2D Feather Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6668
Graph:Graph Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6674
Graph:Plot Legend Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6675
Graph:Plot Legend Auto Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6675
Graph:Plot Legend Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6676
Graph:X Scrollbar Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6676

© National Instruments 131


LabVIEW Programming Reference Manual

Graph:Scale Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6677


Graph:Cursor Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6678
Graph:Plot FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6678
Graph:Plot BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6679
Graph:Bounds Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6679
Graph:Bounds Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6680
Format:X Scale Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6680
Format:Y Scale Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6681
X Scale:Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6682
X Scale:Flipped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6682
X Scale:Mapping Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6683
X Scale:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6683
X Scale:Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6684
X Scale:Scale Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6684
X Scale:Offset and Multiplier:Offset . . . . . . . . . . . . . . . . . . . . . . . 6685
X Scale:Offset and Multiplier:Multiplier . . . . . . . . . . . . . . . . . . . . 6685
X Scale:Tick:Major Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6686
X Scale:Tick:Minor Tick Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6687
X Scale:Grid:Major Grid Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6687
X Scale:Grid:Minor Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6688
X Scale:Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6688
X Scale:Range:Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6689
X Scale:Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6689
X Scale:Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . . . 6690
X Scale:Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6690
X Scale:Marker:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6691
X Scale:Marker:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6692
X Scale:Marker:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6692
X Scale:Marker:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6693
X Scale:Marker:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6693
X Scale:Marker:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6694
X Scale:Marker:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6694
X Scale:Marker:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6695
X Scale:Marker:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . 6695
X Scale:Name Label:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6696
X Scale:Name Label:FG Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6697

132 ni.com
LabVIEW Programming Reference Manual

X Scale:Name Label:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6697


X Scale:Name Label:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6698
X Scale:Name Label:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6698
X Scale:Name Label:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . 6699
X Scale:Name Label:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . 6699
X Scale:Name Label:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . 6700
X Scale:Name Label:Font Underline . . . . . . . . . . . . . . . . . . . . . . . 6700
X Scale:Name Label:Justification . . . . . . . . . . . . . . . . . . . . . . . . . 6701
X Scale:Name Label:Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6702
Y Scale:Editable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6702
Y Scale:Filpped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6703
Y Scale:Mapping Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6703
Y Scale:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6704
Y Scale:Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6704
Y Scale:Scale Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6705
Y Scale:Offset and Multiplier:Offset . . . . . . . . . . . . . . . . . . . . . . . 6705
Y Scale:Offset and Multiplier:Multiplier . . . . . . . . . . . . . . . . . . . . 6706
Y Scale:Tick:Major Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6707
Y Scale:Tick:Minor Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6707
Y Scale:Grid:Major Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6708
Y Scale:Grid:Minor Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6708
Y Scale:Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6709
Y Scale:Range:Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6709
Y Scale:Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6710
Y Scale:Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . . . 6710
Y Scale:Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6711
Y Scale:Marker:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6712
Y Scale:Marker:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6712
Y Scale:Marker:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6713
Y Scale:Marker:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6713
Y Scale:Marker:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6714
Y Scale:Marker:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6714
Y Scale:Marker:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6715
Y Scale:Marker:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6715
Y Scale:Marker:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . 6716
Y Scale:Name Label:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6717

© National Instruments 133


LabVIEW Programming Reference Manual

Y Scale:Name Label:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6717


Y Scale:Name Label:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6718
Y Scale:Name Label:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6718
Y Scale:Name Label:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6719
Y Scale:Name Label:Font Bold. . . . . . . . . . . . . . . . . . . . . . . . . . . . 6719
Y Scale:Name Label:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . 6720
Y Scale:Name Label:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . 6720
Y Scale:Name Label:Font Underline . . . . . . . . . . . . . . . . . . . . . . . 6721
Y Scale:Name Label:Justification . . . . . . . . . . . . . . . . . . . . . . . . . 6722
Y Scale:Name Label:Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6722
Cursor:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6723
Cursor:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6723
Cursor:Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6724
Cursor:Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6724
Cursor:Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6725
Cursor:Name Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6725
Cursor:Allow Drag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6726
Cursor:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6727
Cursor:Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6727
Cursor:Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6728
Cursor:Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6728
Cursor:X Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6729
Cursor:Y Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6729
Cursor:Watch Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6730
Cursor:Watch All Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6730
Cursor:Plot Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6731
Cursor:Label Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6732
Cursor:Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6732
Cursor:Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6733
Cursor:Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6733
Cursor:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6734
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6734
Plot Specific:Feather Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6735
Plot Specific:Feather Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6735
Plot Specific:Feather Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . 6736
Plot Specific:Feather Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . 6737

134 ni.com
LabVIEW Programming Reference Manual

Plot Specific:Feather Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6737


Annotation List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6738
2D Feather Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6738
Export Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6738
3D Graphs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6739
3D Surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6739
3D Surface Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6739
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6745
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6745
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6746
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6746
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6747
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 6748
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 6748
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 6749
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6749
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6750
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6750
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 6751
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6751
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6752
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6753
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6753
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6754
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6754
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6755
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6755
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6756
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6756
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 6757
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 6758
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 6758
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 6759
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 6759
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6760
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6760

© National Instruments 135


LabVIEW Programming Reference Manual

Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 6761


Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 6762
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6762
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6763
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6763
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6764
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6764
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6765
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6765
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6766
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6767
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6767
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6768
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6768
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6769
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6769
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6770
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6770
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 6771
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 6772
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 6772
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6773
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6773
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6774
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6774
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6775
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 6775
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 6776
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 6777
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 6777
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 6778
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 6778
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 6779
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 6779
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 6780
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 6780

136 ni.com
LabVIEW Programming Reference Manual

Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6781


Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 6782
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 6782
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 6783
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 6783
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 6784
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 6784
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 6785
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6785
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6786
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6787
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 6787
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 6788
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 6788
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 6789
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6789
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6790
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6791
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 6791
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 6792
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 6792
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 6793
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 6793
Plot Specific:Surface:Draw Surface . . . . . . . . . . . . . . . . . . . . . . . 6794
Plot Specific:Surface:Draw Mesh. . . . . . . . . . . . . . . . . . . . . . . . . . 6794
Plot Specific:Surface:Draw Normal . . . . . . . . . . . . . . . . . . . . . . . 6795
Plot Specific:Surface:Surface Color Ramp . . . . . . . . . . . . . . . . . 6796
Plot Specific:Surface:Surface Line Style . . . . . . . . . . . . . . . . . . . 6796
Plot Specific:Surface:Surface Line Width . . . . . . . . . . . . . . . . . . 6797
Plot Specific:Surface:Surface Line Color . . . . . . . . . . . . . . . . . . . 6797
Plot Specific:Surface:Surface Line Anti-aliasing . . . . . . . . . . . . 6798
Plot Specific:Surface:Surface Color Mode . . . . . . . . . . . . . . . . . . 6798
3D Surface Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6799
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6799
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6800
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6800

© National Instruments 137


LabVIEW Programming Reference Manual

Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6801


Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6802
3D Mesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6803
3D Mesh Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6803
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6808
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6808
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6809
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6809
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6810
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 6810
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 6811
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 6812
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6812
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6813
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6813
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 6814
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6814
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6815
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6815
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6816
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6817
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6817
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6818
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6818
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6819
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6819
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 6820
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 6820
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 6821
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 6822
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 6822
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6823
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6823
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 6824
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 6824
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6825

138 ni.com
LabVIEW Programming Reference Manual

Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6826


Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6826
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6827
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6827
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6828
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6828
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6829
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6829
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6830
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6831
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6831
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6832
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6832
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6833
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6833
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 6834
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 6834
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 6835
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6836
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6836
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6837
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6837
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6838
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 6838
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 6839
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 6839
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 6840
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 6841
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 6841
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 6842
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 6842
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 6843
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 6843
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6844
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 6844
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 6845

© National Instruments 139


LabVIEW Programming Reference Manual

Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 6846


Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 6846
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 6847
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 6847
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 6848
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6848
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6849
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6849
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 6850
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 6851
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 6851
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 6852
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6852
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6853
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6853
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 6854
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 6855
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 6855
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 6856
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 6856
Plot Specific:Mesh:Fill Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6857
Plot Specific:Mesh:Mesh Line Style . . . . . . . . . . . . . . . . . . . . . . . 6857
Plot Specific:Mesh:Mesh Line Width. . . . . . . . . . . . . . . . . . . . . . . 6858
Plot Specific:Mesh:Mesh Color Ramp . . . . . . . . . . . . . . . . . . . . . 6858
Plot Specific:Mesh:Mesh Line Anti-aliasing . . . . . . . . . . . . . . . . 6859
Plot Specific:Mesh:Mesh Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . 6860
3D Mesh Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6860
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6861
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6861
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6862
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6862
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6863
3D Waterfall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6864
3D Waterfall Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6864
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6869
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6870

140 ni.com
LabVIEW Programming Reference Manual

Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6870


Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6871
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6871
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 6872
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 6872
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 6873
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6873
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6874
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6875
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 6875
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6876
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6876
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6877
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6877
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6878
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6878
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6879
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6880
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6880
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6881
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 6881
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 6882
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 6882
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 6883
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 6884
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6884
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6885
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 6885
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 6886
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6886
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6887
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6888
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6888
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6889
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6889
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6890

© National Instruments 141


LabVIEW Programming Reference Manual

Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6890


Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6891
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6891
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6892
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6893
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6893
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6894
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6894
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6895
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 6895
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 6896
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 6896
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6897
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6898
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6898
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6899
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6899
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 6900
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 6900
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 6901
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 6901
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 6902
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 6903
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 6903
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 6904
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 6904
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 6905
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6905
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 6906
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 6906
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 6907
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 6908
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 6908
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 6909
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 6909
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6910

142 ni.com
LabVIEW Programming Reference Manual

Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6910


Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6911
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 6911
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 6912
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 6913
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 6913
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6914
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6914
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6915
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 6915
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 6916
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 6917
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 6917
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 6918
Plot Specific:Waterfall:Waterfall Line Style . . . . . . . . . . . . . . . . . 6918
Plot Specific:Waterfall:Waterfall Line Width . . . . . . . . . . . . . . . . 6919
Plot Specific:Waterfall:Waterfall Color Ramp . . . . . . . . . . . . . . . 6919
Plot Specific:Waterfall:Waterfall Line Anti-aliasing . . . . . . . . . . 6920
Plot Specific:Waterfall:Waterfall Mode . . . . . . . . . . . . . . . . . . . . 6921
3D Waterfall Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6921
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6922
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6922
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6923
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6923
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6924
3D Ribbon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6925
3D Ribbon Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6925
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6930
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6931
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6931
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6932
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6932
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 6933
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 6933
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 6934
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6934

© National Instruments 143


LabVIEW Programming Reference Manual

Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6935


Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6936
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 6936
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6937
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6937
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6938
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6938
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6939
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6939
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6940
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6941
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6941
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6942
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 6942
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 6943
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 6943
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 6944
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 6945
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6945
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6946
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 6946
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 6947
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6947
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6948
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6949
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6949
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6950
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6950
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6951
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6951
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6952
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6952
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6953
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6954
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6954
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6955

144 ni.com
LabVIEW Programming Reference Manual

Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6955


Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6956
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 6956
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 6957
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 6957
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6958
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6959
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6959
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6960
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6960
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 6961
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 6961
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 6962
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 6962
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 6963
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 6964
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 6964
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 6965
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 6965
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 6966
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6966
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 6967
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 6967
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 6968
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 6969
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 6969
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 6970
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 6970
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6971
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 6971
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6972
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 6972
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 6973
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 6974
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 6974
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6975

© National Instruments 145


LabVIEW Programming Reference Manual

Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6975


Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 6976
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 6976
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 6977
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 6978
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 6978
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 6979
Plot Specific:Ribbon:Draw Ribbon . . . . . . . . . . . . . . . . . . . . . . . . 6979
Plot Specific:Ribbon:Ribbon Color Ramp . . . . . . . . . . . . . . . . . . 6980
Plot Specific:Ribbon:Ribbon Line Style . . . . . . . . . . . . . . . . . . . . 6980
Plot Specific:Ribbon:Ribbon Line Width . . . . . . . . . . . . . . . . . . . 6981
Plot Specific:Ribbon:Ribbon Line Color . . . . . . . . . . . . . . . . . . . 6981
Plot Specific:Ribbon:Ribbon Line Anti-aliasing . . . . . . . . . . . . . 6982
Plot Specific:Ribbon:Ribbon Mode . . . . . . . . . . . . . . . . . . . . . . . . 6983
Plot Specific:Ribbon:Ribbon Width . . . . . . . . . . . . . . . . . . . . . . . 6983
3D Ribbon Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6984
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6984
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6985
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6985
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6986
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6987
3D Contour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6987
3D Contour Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6987
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6993
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6994
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6994
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6995
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6995
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 6996
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 6996
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 6997
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6997
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6998
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 6999
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 6999
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7000

146 ni.com
LabVIEW Programming Reference Manual

Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7000


Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7001
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7001
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7002
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7002
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7003
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7004
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7004
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7005
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 7005
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 7006
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 7006
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 7007
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 7008
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7008
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7009
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 7009
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 7010
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7010
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7011
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7012
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7012
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7013
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7013
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7014
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7014
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7015
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7015
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7016
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7017
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7017
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7018
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7018
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7019
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 7019
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7020

© National Instruments 147


LabVIEW Programming Reference Manual

Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 7020


Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7021
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7022
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7022
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7023
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7023
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 7024
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 7024
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 7025
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 7025
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 7026
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 7027
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 7027
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 7028
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7028
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 7029
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7029
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 7030
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7030
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 7031
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 7032
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 7032
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 7033
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 7033
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7034
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7034
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7035
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 7035
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 7036
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 7037
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 7037
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7038
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7038
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 7039
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 7039
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 7040

148 ni.com
LabVIEW Programming Reference Manual

Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 7041


Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 7041
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 7042
Plot Specific:Contour:Contour Line Style . . . . . . . . . . . . . . . . . . 7042
Plot Specific:Contour:Contour Line Width . . . . . . . . . . . . . . . . . 7043
Plot Specific:Contour:Contour Line Color . . . . . . . . . . . . . . . . . 7043
Plot Specific:Contour:Contour Line Anti-aliasing . . . . . . . . . . . 7044
Plot Specific:Contour:Contour Color Ramp . . . . . . . . . . . . . . . . 7045
Plot Specific:Contour:Contour Mode . . . . . . . . . . . . . . . . . . . . . . 7045
Plot Specific:Contour:Contour Axis Basis . . . . . . . . . . . . . . . . . . 7046
Plot Specific:Contour:Contour Level List . . . . . . . . . . . . . . . . . . 7046
Plot Specific:Contour:Contour Level Mode . . . . . . . . . . . . . . . . 7047
Plot Specific:Contour:Contour Levels . . . . . . . . . . . . . . . . . . . . . 7047
Plot Specific:Contour:Contour Interval . . . . . . . . . . . . . . . . . . . . 7048
3D Contour Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7048
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7049
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7049
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7050
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7050
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7051
3D Quiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7052
3D Quiver Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7052
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7057
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7058
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7059
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7059
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7060
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 7060
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 7061
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 7061
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7062
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7062
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7063
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 7064
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7064
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7065

© National Instruments 149


LabVIEW Programming Reference Manual

Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7065


Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7066
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7066
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7067
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7067
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7068
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7069
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7069
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 7070
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 7070
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 7071
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 7071
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 7072
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7073
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7073
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 7074
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 7074
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7075
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7075
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7076
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7076
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7077
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7078
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7078
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7079
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7079
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7080
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7080
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7081
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7081
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7082
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7083
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7083
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 7084
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7084
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 7085

150 ni.com
LabVIEW Programming Reference Manual

Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7085


Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7086
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7086
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7087
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7088
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 7088
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 7089
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 7089
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 7090
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 7090
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 7091
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 7091
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 7092
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7093
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 7093
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7094
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 7094
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7095
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 7095
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 7096
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 7096
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 7097
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 7098
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7098
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7099
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7099
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 7100
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 7100
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 7101
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 7102
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7102
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7103
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 7103
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 7104
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 7104
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 7105

© National Instruments 151


LabVIEW Programming Reference Manual

Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 7106


Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 7106
Plot Specific:Quiver:Quiver Line Style . . . . . . . . . . . . . . . . . . . . . 7107
Plot Specific:Quiver:Quiver Line Width . . . . . . . . . . . . . . . . . . . . 7107
Plot Specific:Quiver:Quiver Line Color . . . . . . . . . . . . . . . . . . . . 7108
Plot Specific:Quiver:Quiver Line Anti-aliasing . . . . . . . . . . . . . . 7108
Plot Specific:Quiver:Quiver Color Ramp . . . . . . . . . . . . . . . . . . . 7109
Plot Specific:Quiver:Quiver Mode . . . . . . . . . . . . . . . . . . . . . . . . . 7109
Plot Specific:Quiver:Quiver Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7110
Plot Specific:Quiver:Quiver Length . . . . . . . . . . . . . . . . . . . . . . . 7111
3D Quiver Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7111
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7112
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7112
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7113
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7113
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7114
3D Stem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7115
3D Stem Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7115
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7120
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7121
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7121
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7122
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7122
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 7123
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 7123
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 7124
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7124
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7125
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7126
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 7126
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7127
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7127
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7128
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7128
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7129
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7129

152 ni.com
LabVIEW Programming Reference Manual

Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7130


Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7131
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7131
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7132
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 7132
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 7133
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 7133
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 7134
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 7135
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7135
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7136
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 7136
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 7137
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7137
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7138
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7139
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7139
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7140
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7140
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7141
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7141
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7142
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7142
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7143
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7144
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7144
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7145
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7145
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7146
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 7146
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7147
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 7147
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7148
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7149
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7149
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7150

© National Instruments 153


LabVIEW Programming Reference Manual

Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7150


Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 7151
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 7151
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 7152
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 7152
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 7153
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 7154
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 7154
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 7155
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7155
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 7156
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7156
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 7157
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7157
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 7158
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 7159
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 7159
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 7160
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 7160
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7161
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7161
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7162
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 7162
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 7163
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 7164
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 7164
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7165
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7165
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 7166
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 7166
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 7167
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 7168
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 7168
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 7169
Plot Specific:Stem:Stem Point Style . . . . . . . . . . . . . . . . . . . . . . . 7169
Plot Specific:Stem:Stem Point Size . . . . . . . . . . . . . . . . . . . . . . . 7170

154 ni.com
LabVIEW Programming Reference Manual

Plot Specific:Stem:Stem Color Ramp . . . . . . . . . . . . . . . . . . . . . . 7170


Plot Specific:Stem:Stem Line Style. . . . . . . . . . . . . . . . . . . . . . . . 7171
Plot Specific:Stem:Stem Line Width . . . . . . . . . . . . . . . . . . . . . . . 7171
Plot Specific:Stem:Stem Line Color . . . . . . . . . . . . . . . . . . . . . . . 7172
Plot Specific:Stem:Stem Line Anti-aliasing. . . . . . . . . . . . . . . . . 7173
3D Stem Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7173
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7174
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7174
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7175
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7175
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7176
3D Scatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7177
3D Scatter Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7177
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7182
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7182
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7183
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7183
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7184
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 7185
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 7185
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 7186
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7186
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7187
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7187
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 7188
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7188
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7189
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7190
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7190
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7191
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7191
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7192
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7192
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7193
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7193
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 7194

© National Instruments 155


LabVIEW Programming Reference Manual

Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 7195


Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 7195
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 7196
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 7196
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7197
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7197
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 7198
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 7199
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7199
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7200
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7200
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7201
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7201
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7202
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7202
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7203
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7204
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7204
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7205
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7205
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7206
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7206
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7207
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7207
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 7208
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7209
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 7209
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7210
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7210
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7211
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7211
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7212
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 7212
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 7213
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 7214
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 7214

156 ni.com
LabVIEW Programming Reference Manual

Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 7215


Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 7215
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 7216
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 7216
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7217
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 7217
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7218
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 7219
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7219
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 7220
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 7220
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 7221
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 7221
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 7222
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7222
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7223
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7224
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 7224
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 7225
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 7225
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 7226
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7226
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7227
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 7228
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 7228
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 7229
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 7229
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 7230
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 7230
Plot Specific:Scatter:Scatter Point Style . . . . . . . . . . . . . . . . . . . 7231
Plot Specific:Scatter:Scatter Point Size . . . . . . . . . . . . . . . . . . . . 7231
Plot Specific:Scatter:Scatter Color Ramp . . . . . . . . . . . . . . . . . . 7232
3D Scatter Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7233
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7233
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7233
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7234

© National Instruments 157


LabVIEW Programming Reference Manual

Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7234


Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7235
3D Comet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7236
3D Comet Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7236
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7241
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7242
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7242
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7243
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7244
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 7244
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 7245
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 7245
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7246
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7246
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7247
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 7247
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7248
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7249
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7249
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7250
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7250
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7251
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7251
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7252
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7252
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7253
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 7254
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 7254
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 7255
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 7255
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 7256
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7256
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7257
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 7258
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 7258
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7259

158 ni.com
LabVIEW Programming Reference Manual

Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7259


Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7260
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7260
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7261
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7261
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7262
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7263
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7263
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7264
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7264
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7265
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7265
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7266
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7266
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7267
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 7268
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7268
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 7269
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7269
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7270
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7270
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7271
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7271
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 7272
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 7273
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 7273
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 7274
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 7274
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 7275
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 7275
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 7276
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7276
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 7277
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7278
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 7278
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7279

© National Instruments 159


LabVIEW Programming Reference Manual

Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 7279


Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 7280
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 7280
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 7281
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 7281
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7282
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7283
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7283
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 7284
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 7284
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 7285
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 7285
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7286
Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7287
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 7287
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 7288
Plot Specific:General:Coordinates System . . . . . . . . . . . . . . . . . 7288
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 7289
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 7289
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 7290
Plot Specific:Comet:Comet Point Style . . . . . . . . . . . . . . . . . . . . 7290
Plot Specific:Comet:Comet Point Size . . . . . . . . . . . . . . . . . . . . . 7291
Plot Specific:Comet:Comet Point Color . . . . . . . . . . . . . . . . . . . 7292
Plot Specific:Comet:Comet Line Style . . . . . . . . . . . . . . . . . . . . . 7292
Plot Specific:Comet:Comet Line Width . . . . . . . . . . . . . . . . . . . . 7293
Plot Specific:Comet:Comet Line Color . . . . . . . . . . . . . . . . . . . . 7293
Plot Specific:Comet:Comet Line Anti-aliasing . . . . . . . . . . . . . . 7294
3D Comet Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7294
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7295
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7295
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7296
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7296
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7297
3D Pie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7298
3D Pie Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7298
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7303

160 ni.com
LabVIEW Programming Reference Manual

Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7304


Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7304
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7305
Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7305
Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 7306
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 7306
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 7307
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7307
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7308
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7309
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 7309
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7310
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7310
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7311
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7311
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7312
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7312
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7313
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7314
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7314
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7315
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 7315
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 7316
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 7316
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 7317
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 7318
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7318
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7319
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 7319
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 7320
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7320
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7321
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7322
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7322
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7323
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7323

© National Instruments 161


LabVIEW Programming Reference Manual

Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7324


Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7324
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7325
Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7325
Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7326
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7327
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7327
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7328
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7328
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7329
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 7329
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7330
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 7330
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7331
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7332
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7332
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7333
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7333
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 7334
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 7334
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 7335
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 7335
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 7336
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 7337
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 7337
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 7338
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7338
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 7339
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7339
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 7340
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7340
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 7341
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 7342
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 7342
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 7343
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 7343

162 ni.com
LabVIEW Programming Reference Manual

Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7344


Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7344
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7345
Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 7345
Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 7346
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 7347
Cursors:Text:Cursor Text Background Opacity . . . . . . . . . . . . . 7347
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7348
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 7348
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 7349
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 7349
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 7350
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 7351
Plot Specific:Pie:Pie Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . 7351
Plot Specific:Pie:Pie Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . 7352
Plot Specific:Pie:Pie Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7352
Plot Specific:Pie:Pie Line Anti-aliasing . . . . . . . . . . . . . . . . . . . . 7353
Plot Specific:Pie:Pie Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7353
Plot Specific:Pie:Pie Center Position . . . . . . . . . . . . . . . . . . . . . . 7354
Plot Specific:Pie:Label Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7354
Plot Specific:Pie:Label Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7355
Plot Specific:Pie:Label Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7356
Plot Specific:Pie:Color and Name . . . . . . . . . . . . . . . . . . . . . . . . . 7356
Plot Specific:Pie:Slice Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7357
3D Pie Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7357
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7358
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7358
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7359
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7359
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7360
3D Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7361
3D Bar Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7361
Graph:Fast Draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7366
Graph:Clip Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7366
Graph:Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7367
Graph:Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7367

© National Instruments 163


LabVIEW Programming Reference Manual

Graph:View Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7368


Graph:User Defined View:View Latitude . . . . . . . . . . . . . . . . . . . 7368
Graph:User Defined View:View Longitude . . . . . . . . . . . . . . . . . 7369
Graph:User Defined View:View Distance . . . . . . . . . . . . . . . . . . . 7369
Graph:Grid Plane:XY Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7370
Graph:Grid Plane:YZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7371
Graph:Grid Plane:XZ Plane Visible . . . . . . . . . . . . . . . . . . . . . . . . 7371
Graph:Grid Plane:Grid Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . 7372
Graph:Grid Plane:Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7372
Light:Enable Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7373
Light:Active Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7373
Light:Enable Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7374
Light:Light Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7374
Light:Light Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7375
Light:Light Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7376
Light:Light Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7376
Light:Light Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7377
Axis:Active Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7377
Axis:Name Label:Name Label Color . . . . . . . . . . . . . . . . . . . . . . . 7378
Axis:Name Label:Name Label Size . . . . . . . . . . . . . . . . . . . . . . . . 7378
Axis:Name Label:Name Label Text . . . . . . . . . . . . . . . . . . . . . . . . 7379
Axis:Name Label:Name Label Normal Visible . . . . . . . . . . . . . . 7379
Axis:Name Label:Name Label Opposite Visible . . . . . . . . . . . . . 7380
Axis:Marker:Marker Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7381
Axis:Marker:Marker Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7381
Axis:Marker:Marker Normal Visible. . . . . . . . . . . . . . . . . . . . . . . . 7382
Axis:Marker:Marker Opposite Visible . . . . . . . . . . . . . . . . . . . . . . 7382
Axis:Range:Range Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7383
Axis:Range:Range Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7383
Axis:Range:Range Auto Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7384
Axis:Range:Range Inverted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7384
Axis:Range:Range Logarithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7385
Axis:Grid:Grid Major Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7386
Axis:Grid:Grid Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7386
Axis:Grid:Grid Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7387
Axis:Grid:Grid Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7387

164 ni.com
LabVIEW Programming Reference Manual

Axis:Tick:Tick Major Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7388


Axis:Tick:Tick Major Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7388
Axis:Tick:Tick Major Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7389
Axis:Tick:Tick Minor Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7389
Axis:Tick:Tick Minor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7390
Axis:Tick:Tick Minor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7391
Value Pairs:Active Value Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7391
Value Pairs:Value Pair Label Type . . . . . . . . . . . . . . . . . . . . . . . . . 7392
Value Pairs:Value Pair Tick Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7392
Value Pairs:Value Pair Grid Visible. . . . . . . . . . . . . . . . . . . . . . . . . 7393
Value Pairs:Value Pair Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7393
Format:Axis X Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7394
Format:Axis Y Format String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7394
Format:Axis Z Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7395
Cursors:Active Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7396
Cursors:General:Cursor Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . 7396
Cursors:General:Cursor Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 7397
Cursors:General:Cursor Lock Style . . . . . . . . . . . . . . . . . . . . . . . . 7397
Cursors:General:Cursor Plot ID . . . . . . . . . . . . . . . . . . . . . . . . . . . 7398
Cursors:General:Cursor X Position . . . . . . . . . . . . . . . . . . . . . . . . 7398
Cursors:General:Cursor Y Position . . . . . . . . . . . . . . . . . . . . . . . . 7399
Cursors:General:Cursor Z Position . . . . . . . . . . . . . . . . . . . . . . . . 7399
Cursors:Point:Cursor Point Color . . . . . . . . . . . . . . . . . . . . . . . . . 7400
Cursors:Point:Cursor Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 7401
Cursors:Point:Cursor Point Style. . . . . . . . . . . . . . . . . . . . . . . . . . 7401
Cursors:Line:Cursor Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7402
Cursors:Line:Cursor Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 7402
Cursors:Line:Cursor Line Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7403
Cursors:Plane:Cursor Plane Color . . . . . . . . . . . . . . . . . . . . . . . . 7403
Cursors:Plane:Cursor Plane Opacity . . . . . . . . . . . . . . . . . . . . . . 7404
Cursors:Plane:Cursor Plane XY Visible . . . . . . . . . . . . . . . . . . . . . 7404
Cursors:Plane:Cursor Plane XZ Visible . . . . . . . . . . . . . . . . . . . . . 7405
Cursors:Plane:Cursor Plane YZ Visible . . . . . . . . . . . . . . . . . . . . . 7406
Cursors:Text:Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7406
Cursors:Text:Cursor Text Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 7407
Cursors:Text:Cursor Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7407

© National Instruments 165


LabVIEW Programming Reference Manual

Cursors:Text:Cursor Show Position . . . . . . . . . . . . . . . . . . . . . . . 7408


Cursors:Text:Cursor Show Name . . . . . . . . . . . . . . . . . . . . . . . . . 7408
Cursors:Text:Cursor Text Background Color . . . . . . . . . . . . . . . . 7409
Cursors:Text:Cursor Name Background Opacity . . . . . . . . . . . . 7410
Cursors:Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7410
Plot Specific:General:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . 7411
Plot Specific:General:Plot Opacity . . . . . . . . . . . . . . . . . . . . . . . . 7411
Plot Specific:Projection:Draw XY Projection. . . . . . . . . . . . . . . . 7412
Plot Specific:Projection:Draw YZ Projection. . . . . . . . . . . . . . . . 7412
Plot Specific:Projection:Draw XZ Projection . . . . . . . . . . . . . . . 7413
Plot Specific:Bar:Bar Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . 7414
Plot Specific:Bar:Bar Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . 7414
Plot Specific:Bar:Bar Line Color . . . . . . . . . . . . . . . . . . . . . . . . . . 7415
Plot Specific:Bar:Bar Line Anti-aliasing . . . . . . . . . . . . . . . . . . . . 7415
Plot Specific:Bar:Bar Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7416
Plot Specific:Bar:Bar Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7416
Plot Specific:Bar:Color and Name . . . . . . . . . . . . . . . . . . . . . . . . 7417
3D Bar Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7417
Clean Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7418
Reset to Default View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7418
Image to Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7419
Image to File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7419
Get Picture Control Ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7420
XY Plot Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7421
XY Plot Matrix Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7421
Graph:Graph Legend Visible. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7426
Graph:Plot Legend Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7427
Graph:Plot Legend Auto Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7428
Graph:Plot Legend Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7428
Graph:Plot FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7429
Graph:Plot BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7429
Graph:Bounds Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7430
Graph:Bounds Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7430
Format:X Scale Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7431
Format:Y Scale Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7431
X Scale:Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7432

166 ni.com
LabVIEW Programming Reference Manual

X Scale:Filpped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7433
X Scale:Mapping Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7433
X Scale:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7434
X Scale:Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7434
X Scale:Scale Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7435
X Scale:Offset and Multiplier:Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7435
X Scale:Offset and Multiplier:Multiplier . . . . . . . . . . . . . . . . . . . . . . . . . 7436
X Scale:Tick:Major Tick Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7436
X Scale:Tick:Minor Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7437
X Scale:Grid:Major Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7437
X Scale:Grid:Minor Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7438
X Scale:Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7438
X Scale:Range:Maximum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7439
X Scale:Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7440
X Scale:Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7440
X Scale:Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7441
X Scale:Marker:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7441
X Scale:Marker:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7442
X Scale:Marker:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7442
X Scale:Marker:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7443
X Scale:Marker:Font Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7443
X Scale:Marker:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7444
X Scale:Marker:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7444
X Scale:Marker:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7445
X Scale:Marker:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7445
X Scale:Name Label:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7446
X Scale:Name Label:FG Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7447
X Scale:Name Label:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7447
X Scale:Name Label:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7448
X Scale:Name Label:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7448
X Scale:Name Label:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7449
X Scale:Name Label:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7449
X Scale:Name Label:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7450
X Scale:Name Label:Font Underline. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7450
X Scale:Name Label:Justification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7451
X Scale:Name Label:Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7451

© National Instruments 167


LabVIEW Programming Reference Manual

Y Scale:Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7452
Y Scale:Filpped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7452
Y Scale:Mapping Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7453
Y Scale:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7454
Y Scale:Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7454
Y Scale:Scale Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7455
Y Scale:Offset and Multiplier:Offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7455
Y Scale:Offset and Multiplier:Multiplier . . . . . . . . . . . . . . . . . . . . . . . . . 7456
Y Scale:Tick:Major Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7456
Y Scale:Tick:Minor Tick Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7457
Y Scale:Grid:Major Grid Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7457
Y Scale:Grid:Minor Grid Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7458
Y Scale:Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7458
Y Scale:Range:Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7459
Y Scale:Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7459
Y Scale:Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7460
Y Scale:Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7461
Y Scale:Marker:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7461
Y Scale:Marker:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7462
Y Scale:Marker:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7462
Y Scale:Marker:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7463
Y Scale:Marker:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7463
Y Scale:Marker:Font Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7464
Y Scale:Marker:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7464
Y Scale:Marker:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7465
Y Scale:Marker:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7465
Y Scale:Name Label:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7466
Y Scale:Name Label:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7466
Y Scale:Name Label:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7467
Y Scale:Name Label:Font Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7468
Y Scale:Name Label:Font Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7468
Y Scale:Name Label:Font Bold. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7469
Y Scale:Name Label:Font Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7469
Y Scale:Name Label:Font Strike . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7470
Y Scale:Name Label:Font Underline . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7470
Y Scale:Name Label:Justification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7471

168 ni.com
LabVIEW Programming Reference Manual

Y Scale:Name Label:Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7471


Plot Specific:Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7472
Plot Specific:Active Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7472
Plot Specific:Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7473
Plot Specific:Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7474
Plot Specific:Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7474
Plot Specific:Point Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7475
Plot Specific:Interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7475
Plot Specific:Plot Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7476
Plot Specific:Fill Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7476
XY Plot Matrix Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7477
Export Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7477
Network Stream Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7478
Network Stream Endpoint Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7478
Available Elements for Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7479
Available Elements for Writing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7479
Buffer Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7479
Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7480
Endpoint Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7480
Is Connected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7480
Is Readable?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7481
Is Writable? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7481
Number of Disconnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7481
Number of Disconnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7482
Number of Disconnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7482
Number of Disconnections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7482
URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7483
Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7483
Variable Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7483
PSP Variable Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7483
PSP Variable Engine Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7483
Remote PSP Engines[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7484
I/O Variable Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7484
I/O Variable Engine Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7484
Current Faults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7484
Fault Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7485

© National Instruments 169


LabVIEW Programming Reference Manual

IO Forcing Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7485


IO Scan Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7486
IO Scan Period(uSec) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7486
I/O Variable Engine Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7486
Clear All Faults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7487
Clear Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7487
Clear Fault Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7488
Clear Variable Forcing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7488
Get Fault List (Time Critical) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7488
Refresh Local Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7489
Set Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7489
Set Fault Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7489
Wait on IO Scan Falling Edge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7489
Variable Engine Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7490
Class Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7490
Root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7490
URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7491
Variable Engine Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7491
Is Kind Of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7491
Variable Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7491
Variable Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7492
PSP Variable Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7492
PSP Variable Container Properties . . . . . . . . . . . . . . . . . . . . . . . . 7492
As PSP Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7492
I/O Variable Container . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7492
Variable Container Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7492
All Variables[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7493
Children[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7493
Variable Container Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7494
Find Descendants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7494
Variable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7494
PSP Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7494
PSP Variable Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7494
Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7495
Connection:Buffer Size in Elements . . . . . . . . . . . . . 7495
Connection:Connected . . . . . . . . . . . . . . . . . . . . . . . . 7495

170 ni.com
LabVIEW Programming Reference Manual

Connection:Elements in Read Buffer . . . . . . . . . . . . 7496


Connection:Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . 7496
Connection:Raw Quality . . . . . . . . . . . . . . . . . . . . . . . 7497
I/O Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7497
I/O Variable Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7497
Force Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7497
Unforce Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7498
Variable Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7498
Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7498
Variable Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7498
Class Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7499
Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7499
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7499
Parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7500
Readable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7500
URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7500
Writable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7501
Variable Object Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7501
Is Kind Of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7501
URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7502
VI Server Properties and Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7502
VI Server Property and Method Characteristics. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7502
Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7504
VI Server Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7504
Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7512
Application Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7512
Bring To Front . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7520
Browse DataSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7520
Class Operator:Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7521
Class Operator:Remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7522
Class Operator:Remove All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7523
Class Operator:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7523
Clear Application Builder Cache . . . . . . . . . . . . . . . . . . . . . . . . . . 7524
Clear Compiled Object Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7525
Clipboard:Empty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7525
Clipboard:Get Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7526

© National Instruments 171


LabVIEW Programming Reference Manual

Clipboard:Read From Clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . 7527


Clipboard:Write to Clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7528
Connection Responsiveness:Check . . . . . . . . . . . . . . . . . . . . . . . 7528
Connection Responsiveness:Information . . . . . . . . . . . . . . . . . . 7529
Data Type Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7531
Debug Connection:Close Debug Connection . . . . . . . . . . . . . . . 7531
Debug Connection:List Applications or Shared Libraries . . . . 7532
Debug Connection:Open Debug Connection . . . . . . . . . . . . . . . 7533
Get Active VI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7534
Get Environment Mode Display Name . . . . . . . . . . . . . . . . . . . . . 7534
Get VI Hierarchy Image Scaled . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7535
Get VI:Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7537
Get VI:ConPane DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7538
Get VI:Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7539
Get VI:Editor Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7540
Get VI:Help Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7541
Get VI:Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7542
Get VI:Is Probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7543
Get VI:Qualified Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7543
Get VI:Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7544
Get VI:Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7545
Get VI:Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7546
LVRT:Disconnect From Slave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7546
LabVIEW Class:All Methods of LVClass . . . . . . . . . . . . . . . . . . . . . 7547
LabVIEW Class:Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7548
LabVIEW Class:Create Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 7549
LabVIEW Class:Get Implementing VI Path . . . . . . . . . . . . . . . . . . 7550
LabVIEW Class:Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7551
Library:Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7552
Library:Deploy Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7553
Library:Deploy Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7554
Library:Get File LabVIEW Version . . . . . . . . . . . . . . . . . . . . . . . . . 7554
Library:Get Ref By Qualified Name . . . . . . . . . . . . . . . . . . . . . . . . 7555
Library:Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7556
Library:Undeploy Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7557
Library:Undeploy Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7557

172 ni.com
LabVIEW Programming Reference Manual

Mass Compile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7558


Menus:Refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7560
NI Security:Get Access Rights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7560
NI Security:Invoke Login Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . 7561
NI Security:Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7561
NI Security:Logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7562
New LabVIEW Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7563
Open:LabVIEW Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7564
Open:Recently Opened File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7565
Open:Recently Opened Project . . . . . . . . . . . . . . . . . . . . . . . . . . . 7566
Palettes:Close All Palettes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7566
Palettes:Get Palette Item Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7567
Palettes:Refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7567
Project:Get File LabVIEW Version . . . . . . . . . . . . . . . . . . . . . . . . . 7568
Project:New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7569
Project:New with Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7570
Project:Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7570
Project:Open And Suppress Source-Only . . . . . . . . . . . . . . . . . . 7571
Recently Opened:LV Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7571
Recently Opened:LV Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7572
Remote Panel:Client Release Control . . . . . . . . . . . . . . . . . . . . . 7573
Remote Panel:Client Request Control . . . . . . . . . . . . . . . . . . . . . 7574
Remote Panel:Close Connection To Server . . . . . . . . . . . . . . . . 7576
Remote Panel:Open Connection To Server . . . . . . . . . . . . . . . . 7577
Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7578
Scene:Drawable:Geometry:New Box . . . . . . . . . . . . . . . . . . . . . . 7579
Scene:Drawable:Geometry:New Cone. . . . . . . . . . . . . . . . . . . . . 7579
Scene:Drawable:Geometry:New Cylinder . . . . . . . . . . . . . . . . . . 7580
Scene:Drawable:Geometry:New Height Field . . . . . . . . . . . . . . 7580
Scene:Drawable:Geometry:New Mesh . . . . . . . . . . . . . . . . . . . . 7581
Scene:Drawable:Geometry:New Sphere . . . . . . . . . . . . . . . . . . . 7581
Scene:Drawable:New Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7581
Scene:New Clip Plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7582
Scene:New Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7582
Scene:New Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7583
Scene:New Texture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7583

© National Instruments 173


LabVIEW Programming Reference Manual

Scene:New Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7584


Scene:Read Scene File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7584
Scene:Write Scene File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7585
Statechart:Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7586
Statechart:Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7587
User Interaction:Hilight Palette Menu Item . . . . . . . . . . . . . . . . 7587
User Interaction:Invoke Menu Item . . . . . . . . . . . . . . . . . . . . . . . 7588
User Interaction:Place Object On Cursor . . . . . . . . . . . . . . . . . . 7589
User Interaction:Place Palette Object on Cursor . . . . . . . . . . . . 7590
User Interaction:Show Palette Object Context Help . . . . . . . . . 7591
VIs Strings:Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7591
VIs Strings:Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7593
Web Server:Configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7594
XControl:Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7595
XControl:Open. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7595
Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7596
Application:Active:Application . . . . . . . . . . . . . . . . . . . . . . . . . . . 7604
Application:Active:VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7604
Application:All Libraries in Application Instance . . . . . . . . . . . . 7605
Application:All VIs In Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7605
Application:Auto-Route Wires . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7606
Application:Command Line Arguments . . . . . . . . . . . . . . . . . . . 7606
Application:Compiler Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . 7607
Application:Current Environment Mode . . . . . . . . . . . . . . . . . . . 7608
Application:Debug Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7609
Application:Default:Application . . . . . . . . . . . . . . . . . . . . . . . . . . 7609
Application:Default:Data Directory . . . . . . . . . . . . . . . . . . . . . . . 7610
Application:Delete FP Terminal from Diagram . . . . . . . . . . . . . 7610
Application:Directory Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7611
Application:Exported VIs In Memory . . . . . . . . . . . . . . . . . . . . . . 7611
Application:Kind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7612
Application:Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7612
Application:Menu Launch:App . . . . . . . . . . . . . . . . . . . . . . . . . . . 7613
Application:Menu Launch:VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7613
Application:Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7614
Application:Save Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7614

174 ni.com
LabVIEW Programming Reference Manual

Application:Saveable Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . 7615


Application:Show FP Tip Strips . . . . . . . . . . . . . . . . . . . . . . . . . . . 7615
Application:Target:CPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7616
Application:Target:Data Cache Entry Sizes . . . . . . . . . . . . . . . . . 7617
Application:Target:Data Cache Sizes . . . . . . . . . . . . . . . . . . . . . . 7617
Application:Target:Number of Cores per Package . . . . . . . . . . 7618
Application:Target:Number of Logical Processors . . . . . . . . . . 7619
Application:Target:Number of Logical Processors per Core . . 7619
Application:Target:Number of Packages . . . . . . . . . . . . . . . . . . . 7620
Application:Target:Operating System . . . . . . . . . . . . . . . . . . . . . 7621
Application:User Interface Available . . . . . . . . . . . . . . . . . . . . . . 7621
Application:User Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7622
Application:VI Of Top Most Block Diagram . . . . . . . . . . . . . . . . . 7622
Application:Version Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7623
Application:Version Year . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7623
Debug Server:Server Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7624
Debug Server:TCP/IP Access List . . . . . . . . . . . . . . . . . . . . . . . . . . 7624
Display:All Monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7625
Display:Primary Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7625
NI Security:Nobody Logged In? . . . . . . . . . . . . . . . . . . . . . . . . . . . 7626
NI Security:User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7627
Operating System:Build Number . . . . . . . . . . . . . . . . . . . . . . . . . 7627
Operating System:Detailed Name . . . . . . . . . . . . . . . . . . . . . . . . 7628
Operating System:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7628
Operating System:Version Number . . . . . . . . . . . . . . . . . . . . . . . 7629
Palettes:Controls Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7630
Palettes:Functions Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7630
Printing:Available Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7631
Printing:Color/Grayscale? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7631
Printing:Custom All Controls? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7632
Printing:Custom Cluster Constants? . . . . . . . . . . . . . . . . . . . . . . 7633
Printing:Custom Connector? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7633
Printing:Custom Control Descriptions? . . . . . . . . . . . . . . . . . . . . 7634
Printing:Custom Control Label/Caption? . . . . . . . . . . . . . . . . . . 7634
Printing:Custom Control Types? . . . . . . . . . . . . . . . . . . . . . . . . . . 7635
Printing:Custom Controls? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7635

© National Instruments 175


LabVIEW Programming Reference Manual

Printing:Custom Description? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7636


Printing:Custom Diagram Hidden? . . . . . . . . . . . . . . . . . . . . . . . . 7636
Printing:Custom Diagram Repeat? . . . . . . . . . . . . . . . . . . . . . . . . 7637
Printing:Custom Diagram? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7638
Printing:Custom Express VI Configuration? . . . . . . . . . . . . . . . . 7638
Printing:Custom Hierarchy? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7639
Printing:Custom History? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7639
Printing:Custom List of SubVIs? . . . . . . . . . . . . . . . . . . . . . . . . . . 7640
Printing:Custom Panel Border? . . . . . . . . . . . . . . . . . . . . . . . . . . . 7640
Printing:Custom Panel?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7641
Printing:Default Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7642
Printing:File Wrap Text Length . . . . . . . . . . . . . . . . . . . . . . . . . . . 7642
Printing:JPEG Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7643
Printing:Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7643
Printing:PNG Compression Level . . . . . . . . . . . . . . . . . . . . . . . . . 7644
Project:Active Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7645
Project:Owning Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7645
Project:Projects[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7646
Project:Target Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7646
Remote Panel:Connections To Clients . . . . . . . . . . . . . . . . . . . . . 7647
Remote Panel:Connections To Servers . . . . . . . . . . . . . . . . . . . . 7648
Server:Logging Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7649
Server:Logging File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7650
Server:Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7650
Server:Service Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7651
Server:TCP Listener Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7651
Server:TCP/IP Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7652
Server:VI Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7653
Web Server:Config File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7654
Web Server:Default Config File Path . . . . . . . . . . . . . . . . . . . . . . 7654
Web Server:HTTP Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7655
Web Server:Logging Enabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7655
Web Server:Logging File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7656
Web Server:Read Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7656
Web Server:Root Directory Path . . . . . . . . . . . . . . . . . . . . . . . . . . 7657
Web Server:Server Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7657

176 ni.com
LabVIEW Programming Reference Manual

Web Server:TCP/IP Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7658


Web Server:VI Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7659
Application Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7660
Application Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7661
Application Instance Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7662
Application Instance Close? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7662
Bookmark Info Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7663
Context Help Window Updated . . . . . . . . . . . . . . . . . . . . . . . . . . . 7664
NI Security User Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7665
Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7666
VI Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7667
VI Deactivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7668
VI Scroll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7669
Generic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7669
Generic Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7669
Class Operator:Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7670
Class Operator:Traverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7671
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7672
Tag:Get Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7673
Tag:Remove Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7674
Tag:Set Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7674
Tag:Set Tag Persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7675
Generic Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7676
Class ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7677
Class Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7678
Is On Block Diagram? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7678
Owner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7679
Owning VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7680
GObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7680
GObject Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7680
Get Help Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7681
Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7682
Object Highlight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7683
Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7684
Replace No Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7685
GObject Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7686

© National Instruments 177


LabVIEW Programming Reference Manual

Bounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7688
Bounds:Area Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7689
Bounds:Area Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7689
Dependencies:Found Dependency Names . . . . . . . . . . . . 7690
Dependencies:Found Dependency Paths . . . . . . . . . . . . . 7691
Dependencies:Missing Dependency Names . . . . . . . . . . . 7692
Dependencies:Missing Dependency Paths . . . . . . . . . . . . 7693
Group Member Refs[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7694
Grouped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7695
Locked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7695
Master Bounds Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7696
Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7697
Position:Left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7698
Position:Top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7699
Selected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7699
Total Bounds Rect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7700
UID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7701
Decoration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7701
Decoration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7702
Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7702
Colors:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7703
Colors:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7704
Owning Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7705
Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7705
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7706
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7707
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7707
Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7708
Text Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7708
Move to Default Location . . . . . . . . . . . . . . . . . 7708
Text Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7709
Attached Object. . . . . . . . . . . . . . . . . . . . . . . . . . 7711
Document Bounds . . . . . . . . . . . . . . . . . . . . . . . 7712
Document Bounds:Height . . . . . . . . . . . . . . . . 7712
Document Bounds:Width . . . . . . . . . . . . . . . . . 7713
Enable Hyperlinks. . . . . . . . . . . . . . . . . . . . . . . . 7714

178 ni.com
LabVIEW Programming Reference Manual

Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7714
Font:Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7715
Font:Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7716
Font:Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7717
Font:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7717
Font:Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7718
Font:Strikeout . . . . . . . . . . . . . . . . . . . . . . . . . . . 7719
Font:Underline . . . . . . . . . . . . . . . . . . . . . . . . . . 7720
Justification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7720
Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7721
Scroll Position . . . . . . . . . . . . . . . . . . . . . . . . . . . 7722
Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7723
Selection:End. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7724
Selection:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . 7725
Size to Text? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7726
Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7726
Text Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7728
Text Colors:BG Color . . . . . . . . . . . . . . . . . . . . . 7729
Text Colors:Text Color . . . . . . . . . . . . . . . . . . . . 7729
Text Overflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7730
Vertical Arrangement . . . . . . . . . . . . . . . . . . . . . 7731
NumericText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7731
NumericText Properties. . . . . . . . . . . . . . . . . . . 7732
Display Format . . . . . . . . . . . . . . . . . . . . . 7732
Display Format:Format . . . . . . . . . . . . . . 7733
Display Format:Precision . . . . . . . . . . . . 7734
Format String . . . . . . . . . . . . . . . . . . . . . . . 7735
Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7736
Scale Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7736
Display Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7738
Display Format:Format . . . . . . . . . . . . . . . . . . . . . . . . 7739
Display Format:Precision . . . . . . . . . . . . . . . . . . . . . . 7740
Editable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7740
Flipped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7741
Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7742
Mapping Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7742

© National Instruments 179


LabVIEW Programming Reference Manual

Marker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7743
Marker Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7744
Marker Colors:BG Color . . . . . . . . . . . . . . . . . . . . . . . . 7744
Marker Colors:Text Color . . . . . . . . . . . . . . . . . . . . . . . 7745
Range. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7746
Range:Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7747
Range:Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7747
Range:Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7748
Range:Minor Increment . . . . . . . . . . . . . . . . . . . . . . . . 7749
Range:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7749
Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7750
Tick Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7752
Tick Colors:Minor Tick Color . . . . . . . . . . . . . . . . . . . 7752
Tick Colors:Tick Color . . . . . . . . . . . . . . . . . . . . . . . . . 7753
Uniform Marker Spacing? . . . . . . . . . . . . . . . . . . . . . . 7754
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7754
ColorScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7755
ColorScale Properties . . . . . . . . . . . . . . . . . . . . . . . . . 7755
High Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7756
Interpolate Color . . . . . . . . . . . . . . . . . . . . . . . . . 7756
Low Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7757
Marker Values[] . . . . . . . . . . . . . . . . . . . . . . . . . . 7758
Ramp Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7759
RotaryColorScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7759
RotaryColorScale Properties . . . . . . . . . . . . . . 7759
Scale Position . . . . . . . . . . . . . . . . . . . . . . 7760
Scale Position:Range . . . . . . . . . . . . . . . . 7761
Scale Position:Start . . . . . . . . . . . . . . . . . 7761
GraphScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7762
GraphScale Properties . . . . . . . . . . . . . . . . . . . . . . . . . 7762
Expand Digital Buses . . . . . . . . . . . . . . . . . . . . . 7763
Grid Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7764
Grid Colors:Major Color . . . . . . . . . . . . . . . . . . . 7765
Grid Colors:Minor Color . . . . . . . . . . . . . . . . . . . 7766
Loose Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7766
Marker Values[] . . . . . . . . . . . . . . . . . . . . . . . . . . 7767

180 ni.com
LabVIEW Programming Reference Manual

Name Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7768


Offset and Multiplier . . . . . . . . . . . . . . . . . . . . . 7769
Offset and Multiplier:Multiplier . . . . . . . . . . . . 7770
Offset and Multiplier:Offset . . . . . . . . . . . . . . . 7770
Scale Fit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7771
Unit Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7772
ColorGraphScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7773
ColorGraphScale Properties. . . . . . . . . . . . . . . . . . . . 7773
High Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7774
Interpolate Color . . . . . . . . . . . . . . . . . . . . . . . . . 7775
Loose Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7775
Low Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7776
Marker Values[] . . . . . . . . . . . . . . . . . . . . . . . . . . 7777
Name Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7778
Offset and Multiplier . . . . . . . . . . . . . . . . . . . . . 7778
Offset and Multiplier:Multiplier . . . . . . . . . . . . 7779
Offset and Multiplier:Offset . . . . . . . . . . . . . . . 7780
Ramp Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7781
Scale Fit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7782
Unit Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7782
SlideScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7783
SlideScale Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 7783
Marker Values[] . . . . . . . . . . . . . . . . . . . . . . . . . . 7784
Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7784
Control Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7784
Attach DataSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7786
Create:Control Reference . . . . . . . . . . . . . . . . . . . . . . 7787
Create:Invoke Node . . . . . . . . . . . . . . . . . . . . . . . . . . . 7788
Create:Local Variable . . . . . . . . . . . . . . . . . . . . . . . . . . 7788
Create:Property Node . . . . . . . . . . . . . . . . . . . . . . . . . 7789
Data Binding:Bind To Network Path . . . . . . . . . . . . . 7789
Data Binding:Unbind . . . . . . . . . . . . . . . . . . . . . . . . . . 7790
Data Operations:Copy Data . . . . . . . . . . . . . . . . . . . . 7791
Data Operations:Paste Data . . . . . . . . . . . . . . . . . . . . 7792
Disconnect From Typedef . . . . . . . . . . . . . . . . . . . . . . 7792
Fit Control To Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7793

© National Instruments 181


LabVIEW Programming Reference Manual

Get Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7793


Get Terminal Image . . . . . . . . . . . . . . . . . . . . . . . . . . . 7796
Reinitialize To Default . . . . . . . . . . . . . . . . . . . . . . . . . 7798
Remove DataSocket . . . . . . . . . . . . . . . . . . . . . . . . . . . 7799
Start Drag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7800
Update From Typedef . . . . . . . . . . . . . . . . . . . . . . . . . 7802
Control Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7803
Auto-Update From Typedef . . . . . . . . . . . . . . . . . . . . 7807
Blinking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7808
Built-In Mouse Wheel Support . . . . . . . . . . . . . . . . . . 7809
Caption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7810
Control Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7810
Control Reference Nodes[] . . . . . . . . . . . . . . . . . . . . . 7811
Data Binding:Binding Type . . . . . . . . . . . . . . . . . . . . . 7812
Data Binding:LED Visible . . . . . . . . . . . . . . . . . . . . . . . 7812
Data Binding:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7813
Data Binding:Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7814
Data Binding:Status . . . . . . . . . . . . . . . . . . . . . . . . . . . 7814
DataSocket:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . 7815
DataSocket:LED Visible . . . . . . . . . . . . . . . . . . . . . . . . 7816
DataSocket:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7817
DataSocket:Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7817
DataSocket:URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7818
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7819
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7819
Default Value (Undoable) . . . . . . . . . . . . . . . . . . . . . . 7820
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7821
Disabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7821
Focus Key Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7822
Grow Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7825
Grow Info:Can Grow Horizontally . . . . . . . . . . . . . . . 7825
Grow Info:Can Grow Vertically . . . . . . . . . . . . . . . . . . 7826
Grow Info:Max Horizontally . . . . . . . . . . . . . . . . . . . . 7827
Grow Info:Max Vertically . . . . . . . . . . . . . . . . . . . . . . . 7827
Grow Info:Min Horizontally . . . . . . . . . . . . . . . . . . . . . 7828
Grow Info:Min Vertically . . . . . . . . . . . . . . . . . . . . . . . 7828

182 ni.com
LabVIEW Programming Reference Manual

Has Caption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7829


Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7830
Invoke Nodes[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7831
Is On Connector Pane . . . . . . . . . . . . . . . . . . . . . . . . . 7831
Is Typedef? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7832
Key Focus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7832
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7833
Local Variables[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7834
Owning Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7834
Property Nodes[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7835
Skip When Tabbing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7836
Style ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7836
Synchronous Display . . . . . . . . . . . . . . . . . . . . . . . . . . 7837
Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7838
Tip Strip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7839
Typedef:Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7839
Typedef:VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7840
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7841
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7841
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7842
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7843
Value (Undoable) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7844
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7844
XControl:Container Bounds . . . . . . . . . . . . . . . . . . . . 7845
XControl:Container Bounds:Height . . . . . . . . . . . . . 7846
XControl:Container Bounds:Width . . . . . . . . . . . . . . 7846
XControl:Is XControl? . . . . . . . . . . . . . . . . . . . . . . . . . . 7847
Control Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7847
Drag Ended . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7849
Drag Enter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7851
Drag Leave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7853
Drag Over . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7854
Drag Source Update . . . . . . . . . . . . . . . . . . . . . . . . . . . 7856
Drop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7857
Key Down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7859
Key Down? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7861

© National Instruments 183


LabVIEW Programming Reference Manual

Key Repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7863


Key Repeat? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7865
Key Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7866
Mouse Down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7868
Mouse Down? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7869
Mouse Enter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7871
Mouse Leave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7871
Mouse Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7872
Mouse Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7873
Mouse Wheel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7874
Shortcut Menu Activation? . . . . . . . . . . . . . . . . . . . . . 7876
Shortcut Menu Dismissed . . . . . . . . . . . . . . . . . . . . . . 7877
Shortcut Menu Selection (App) . . . . . . . . . . . . . . . . . 7877
Shortcut Menu Selection (User) . . . . . . . . . . . . . . . . 7879
Shortcut Menu Selection? (App) . . . . . . . . . . . . . . . . 7880
Value Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7881
ColorBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7882
ColorBox Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 7883
Allow Transparent. . . . . . . . . . . . . . . . . . . . . . . . 7883
Color Area Size. . . . . . . . . . . . . . . . . . . . . . . . . . . 7884
Color Area Size:Height . . . . . . . . . . . . . . . . . . . . 7884
Color Area Size:Width . . . . . . . . . . . . . . . . . . . . 7885
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7886
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7887
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . 7887
Boolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7888
Boolean Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7888
Boolean Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7889
Button Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7890
Button Size:Height . . . . . . . . . . . . . . . . . . . . . . . 7891
Button Size:Width . . . . . . . . . . . . . . . . . . . . . . . . 7891
Colors [4]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7892
Lock Boolean Text In Center . . . . . . . . . . . . . . . 7894
Mechanical Action . . . . . . . . . . . . . . . . . . . . . . . 7895
Multiple Text String. . . . . . . . . . . . . . . . . . . . . . . 7895
Strings [4] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7896

184 ni.com
LabVIEW Programming Reference Manual

Toggle Key Binding . . . . . . . . . . . . . . . . . . . . . . . 7897


RefNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7900
TypedRefNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7900
TypedRefNum Properties . . . . . . . . . . . . . . . . . 7900
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7900
DataValRefNum . . . . . . . . . . . . . . . . . . . . . . . . . . 7901
DataValRefNum Properties . . . . . . . . . . . 7901
Is External . . . . . . . . . . . . . . . . . . . . . 7902
LVObjectRefNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7902
VIRefNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7902
VIRefNum Methods . . . . . . . . . . . . . . . . . . 7903
Make Non-Strict Reference . . . . . . 7903
Make Strict Reference . . . . . . . . . . 7904
Set Conpane . . . . . . . . . . . . . . . . . . . 7905
VIRefNum Properties . . . . . . . . . . . . . . . . 7905
Is Strict? . . . . . . . . . . . . . . . . . . . . . . . 7906
GenClassRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7906
LVVariant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7906
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7906
Path Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7907
Browse for Path . . . . . . . . . . . . . . . . . . . . . . . . . . 7907
Path Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7908
Allow Dropping . . . . . . . . . . . . . . . . . . . . . . . . . . 7909
Browse Button Rect . . . . . . . . . . . . . . . . . . . . . . 7910
Browse Button:Disabled . . . . . . . . . . . . . . . . . . 7911
Browse Button:Visible . . . . . . . . . . . . . . . . . . . . 7911
Browse Options . . . . . . . . . . . . . . . . . . . . . . . . . . 7912
Browse Options:Button Text . . . . . . . . . . . . . . 7913
Browse Options:Match Pattern . . . . . . . . . . . . 7914
Browse Options:Pattern Label . . . . . . . . . . . . . 7915
Browse Options:Prompt . . . . . . . . . . . . . . . . . . 7916
Browse Options:Selection Mode . . . . . . . . . . . 7917
Browse Options:Start Path . . . . . . . . . . . . . . . . 7918
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7919
Path Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7919
Path Too Long To Fit . . . . . . . . . . . . . . . . . . . . . . 7920

© National Instruments 185


LabVIEW Programming Reference Manual

Scrollbar Visible . . . . . . . . . . . . . . . . . . . . . . . . . 7921


Shows Abbreviated Behavior? . . . . . . . . . . . . . 7922
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7922
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7923
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7924
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7925
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . 7925
ListBox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7926
ListBox Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7926
Custom Item Symbols:Get Symbol . . . . . . . . . 7927
Custom Item Symbols:Get Symbol Array . . . 7928
Custom Item Symbols:Revert All To Built In
Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7929
Custom Item Symbols:Revert To Built In
Symbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7930
Custom Item Symbols:Set To Custom Symbol . . . .
7931
Custom Item Symbols:Set To Custom Symbol
Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7932
Get Double-Clicked Row . . . . . . . . . . . . . . . . . . 7933
Point to Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7934
ListBox Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7935
Active Row:Active Row Number. . . . . . . . . . . . 7939
Active Row:Active Row Position. . . . . . . . . . . . 7940
Active Row:Active Row Position:Left . . . . . . . 7941
Active Row:Active Row Position:Top . . . . . . . 7941
Active Row:Cell Background Color . . . . . . . . . 7942
Active Row:Cell Font . . . . . . . . . . . . . . . . . . . . . 7943
Active Row:Cell Font:Bold . . . . . . . . . . . . . . . . . 7944
Active Row:Cell Font:Color . . . . . . . . . . . . . . . . 7945
Active Row:Cell Font:Italic . . . . . . . . . . . . . . . . 7945
Active Row:Cell Font:Name . . . . . . . . . . . . . . . 7946
Active Row:Cell Font:Size . . . . . . . . . . . . . . . . . 7947
Active Row:Cell Font:Strikeout . . . . . . . . . . . . 7948
Active Row:Cell Font:Underline . . . . . . . . . . . . 7948
Active Row:Cell Height. . . . . . . . . . . . . . . . . . . . 7949

186 ni.com
LabVIEW Programming Reference Manual

Active Row:Cell Justification . . . . . . . . . . . . . . 7950


Allow Editing Cells . . . . . . . . . . . . . . . . . . . . . . . 7950
Autosizing Row Height . . . . . . . . . . . . . . . . . . . . 7951
Column Header String . . . . . . . . . . . . . . . . . . . . 7952
Content Rect Bounds . . . . . . . . . . . . . . . . . . . . . 7953
Content Rect Bounds:Height . . . . . . . . . . . . . . 7953
Content Rect Bounds:Width . . . . . . . . . . . . . . . 7954
Content Rect Position . . . . . . . . . . . . . . . . . . . . 7955
Content Rect Position:Left . . . . . . . . . . . . . . . . 7956
Content Rect Position:Top . . . . . . . . . . . . . . . . 7956
Disabled Items . . . . . . . . . . . . . . . . . . . . . . . . . . . 7957
Drag/Drop:Allow Drag and Drop Outside
Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7958
Drag/Drop:Allow Dragging . . . . . . . . . . . . . . . . 7959
Drag/Drop:Allow Dropping . . . . . . . . . . . . . . . . 7960
Drag/Drop:Drag Mode . . . . . . . . . . . . . . . . . . . . 7961
Edit Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7961
Focus Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7962
Is Array? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7963
Item Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7964
Item Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7964
Keyboard Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 7965
Multiple Line Input . . . . . . . . . . . . . . . . . . . . . . . 7966
Number of Rows . . . . . . . . . . . . . . . . . . . . . . . . . 7967
Select Entire Rows . . . . . . . . . . . . . . . . . . . . . . . 7967
Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . 7968
Selection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 7969
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7970
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7970
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7971
Top Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7972
Visible Items:Column Header Visible . . . . . . . 7973
Visible Items:Horizontal Lines Visible. . . . . . . 7973
Visible Items:Symbols Visible . . . . . . . . . . . . . . 7974
Visible Items:Vertical Scrollbar Visible . . . . . . 7975
ListBox Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7976

© National Instruments 187


LabVIEW Programming Reference Manual

Double Click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7976


Drag Starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7978
Drag Starting? . . . . . . . . . . . . . . . . . . . . . . . . . . . 7980
Edit Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7983
Edit Cell? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7984
Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7984
Table Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7985
Export Data to Clipboard . . . . . . . . . . . . . . . . . . 7985
Export Data to Excel . . . . . . . . . . . . . . . . . . . . . . 7986
Export Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7987
Point to Row Column . . . . . . . . . . . . . . . . . . . . . 7988
Set Cell Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7989
Table Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7990
Active Cell:Active Cell . . . . . . . . . . . . . . . . . . . . . 7994
Active Cell:Cell Background Color. . . . . . . . . . 7995
Active Cell:Cell Font . . . . . . . . . . . . . . . . . . . . . . 7996
Active Cell:Cell Font:Bold . . . . . . . . . . . . . . . . . 7997
Active Cell:Cell Font:Color . . . . . . . . . . . . . . . . 7997
Active Cell:Cell Font:Italic . . . . . . . . . . . . . . . . . 7998
Active Cell:Cell Font:Name . . . . . . . . . . . . . . . . 7999
Active Cell:Cell Font:Size . . . . . . . . . . . . . . . . . . 8000
Active Cell:Cell Font:Strikeout . . . . . . . . . . . . . 8000
Active Cell:Cell Font:Underline . . . . . . . . . . . . 8001
Active Cell:Cell Justification . . . . . . . . . . . . . . . 8002
Active Cell:Cell Size. . . . . . . . . . . . . . . . . . . . . . . 8002
Active Cell:Cell Size:Height . . . . . . . . . . . . . . . . 8003
Active Cell:Cell Size:Width . . . . . . . . . . . . . . . . 8004
Active Cell:Position . . . . . . . . . . . . . . . . . . . . . . . 8005
Active Cell:Position:Left . . . . . . . . . . . . . . . . . . . 8005
Active Cell:Position:Top. . . . . . . . . . . . . . . . . . . 8006
Autosizing Row Height . . . . . . . . . . . . . . . . . . . . 8007
Column Header Strings[] . . . . . . . . . . . . . . . . . . 8008
Content Rect Bounds . . . . . . . . . . . . . . . . . . . . . 8008
Content Rect Bounds:Height . . . . . . . . . . . . . . 8009
Content Rect Bounds:Width . . . . . . . . . . . . . . . 8010
Content Rect Position . . . . . . . . . . . . . . . . . . . . 8011

188 ni.com
LabVIEW Programming Reference Manual

Content Rect Position:Left . . . . . . . . . . . . . . . . 8011


Content Rect Position:Top . . . . . . . . . . . . . . . . 8012
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8013
Edit Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8014
Index Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8015
Multiple Line Input . . . . . . . . . . . . . . . . . . . . . . . 8016
Number of Columns . . . . . . . . . . . . . . . . . . . . . . 8016
Number of Rows . . . . . . . . . . . . . . . . . . . . . . . . . 8017
Row Header Strings[] . . . . . . . . . . . . . . . . . . . . . 8018
Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . 8019
Selection Size . . . . . . . . . . . . . . . . . . . . . . . . . . . 8020
Selection Start . . . . . . . . . . . . . . . . . . . . . . . . . . . 8021
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8022
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8022
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8023
Smooth Horizontal Scrolling . . . . . . . . . . . . . . 8024
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8025
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . 8025
Visible Items:Column Headers Visible . . . . . . 8026
Visible Items:Horizontal Lines Visible. . . . . . . 8027
Visible Items:Horizontal Scrollbar Visible . . . 8028
Visible Items:Index Visible . . . . . . . . . . . . . . . . 8028
Visible Items:Row Headers Visible . . . . . . . . . 8029
Visible Items:Vertical Lines Visible . . . . . . . . . 8030
Visible Items:Vertical Scrollbar Visible . . . . . . 8031
Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8031
Array Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8032
Export Data to Clipboard . . . . . . . . . . . . . . . . . . 8032
Export Data to Excel . . . . . . . . . . . . . . . . . . . . . . 8033
Array Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8033
Array Element . . . . . . . . . . . . . . . . . . . . . . . . . . . 8034
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8035
Index Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8036
Index Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8036
Index Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8037
Number Of Dimensions . . . . . . . . . . . . . . . . . . . 8038

© National Instruments 189


LabVIEW Programming Reference Manual

Number of Columns . . . . . . . . . . . . . . . . . . . . . . 8039


Number of Rows . . . . . . . . . . . . . . . . . . . . . . . . . 8039
Selection Size[] . . . . . . . . . . . . . . . . . . . . . . . . . . 8040
Selection Start[] . . . . . . . . . . . . . . . . . . . . . . . . . 8041
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8041
Picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8042
Picture Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8042
Export Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8042
Picture Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8044
Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8045
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8046
Draw Area Size . . . . . . . . . . . . . . . . . . . . . . . . . . . 8046
Erase First . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8047
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8048
Mouse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8049
Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8051
Origin:Left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8052
Origin:Top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8053
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8054
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . 8054
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8055
Zoom Factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8056
ActiveXContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8057
ActiveXContainer Properties . . . . . . . . . . . . . . . . . . . 8057
Container Bounds . . . . . . . . . . . . . . . . . . . . . . . . 8057
Container Bounds:Height . . . . . . . . . . . . . . . . . 8058
Container Bounds:Width . . . . . . . . . . . . . . . . . . 8059
Numeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8059
Numeric Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 8059
Adapt To Source . . . . . . . . . . . . . . . . . . . . . . . . . 8061
Data Entry Limits . . . . . . . . . . . . . . . . . . . . . . . . 8062
Data Entry Limits:Increment . . . . . . . . . . . . . . 8063
Data Entry Limits:Maximum . . . . . . . . . . . . . . . 8064
Data Entry Limits:Minimum . . . . . . . . . . . . . . . 8064
Decrement Key Binding . . . . . . . . . . . . . . . . . . . 8065
Fixed-Point Overflow Status Visible? . . . . . . . 8068

190 ni.com
LabVIEW Programming Reference Manual

Fixed-Point Representation:Actual . . . . . . . . . 8069


Fixed-Point Representation:Actual:Delta . . . 8069
Fixed-Point Representation:Actual:Range Max . . .
8070
Fixed-Point Representation:Actual:Range Min. . . .
8071
Fixed-Point Representation:Bits . . . . . . . . . . . 8072
Fixed-Point Representation:Bits:Integer Word
Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8072
Fixed-Point Representation:Bits:Signed . . . . 8073
Fixed-Point Representation:Bits:Word Length . . . .
8074
Fixed-Point Representation:Desired. . . . . . . . 8075
Fixed-Point Representation:Desired:Delta . . 8075
Fixed-Point Representation:Desired:Range Max . .
8076
Fixed-Point Representation:Desired:Range Min . .
8077
Fixed-Point Representation:Include Overflow
Status? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8078
Increment Key Binding . . . . . . . . . . . . . . . . . . . 8078
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . 8081
Response to Value Outside Limits . . . . . . . . . . 8082
Response to Value Outside Limits:Increment. . . . .
8084
Response to Value Outside Limits:Maximum . . . . .
8085
Response to Value Outside Limits:Minimum . . . . .
8086
Unit Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8087
Digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8088
Digital Properties . . . . . . . . . . . . . . . . . . . . . . . . 8088
Display Format . . . . . . . . . . . . . . . . . . . . . 8089
Display Format:Format . . . . . . . . . . . . . . 8089
Display Format:Precision . . . . . . . . . . . . 8091
Format String . . . . . . . . . . . . . . . . . . . . . . . 8092

© National Instruments 191


LabVIEW Programming Reference Manual

Increment/Decrement Visible? . . . . . . . 8093


Numeric Text . . . . . . . . . . . . . . . . . . . . . . . 8094
Radix Visible? . . . . . . . . . . . . . . . . . . . . . . . 8094
Text Width . . . . . . . . . . . . . . . . . . . . . . . . . . 8095
NamedNumeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8096
NamedNumeric Properties . . . . . . . . . . . . . . . . 8096
Digital Display . . . . . . . . . . . . . . . . . . . . . . 8097
Disabled Items [] . . . . . . . . . . . . . . . . . . . . 8098
Increment/Decrement Visible? . . . . . . . 8098
Named Numeric Size . . . . . . . . . . . . . . . . 8099
Named Numeric Size:Height . . . . . . . . . 8100
Named Numeric Size:Width . . . . . . . . . . 8101
Number of Items . . . . . . . . . . . . . . . . . . . . 8101
Ring Text . . . . . . . . . . . . . . . . . . . . . . . . . . . 8102
Strings [] . . . . . . . . . . . . . . . . . . . . . . . . . . . 8103
NamedNumeric Events . . . . . . . . . . . . . . . . . . . 8104
Operate Menu Activation . . . . . . . . . . . . . 8105
Operate Menu Dismissed . . . . . . . . . . . . 8105
Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8106
Ring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8106
Ring Properties . . . . . . . . . . . . . . . . . . . . . 8106
Allow Undefined Values . . . . . . . . . 8107
Flavor . . . . . . . . . . . . . . . . . . . . . . . . . 8108
Last Value Hidden . . . . . . . . . . . . . . 8109
Strings And Values [] . . . . . . . . . . . . 8109
Strings And Values [] . . . . . . . . . . . . 8111
ColorRamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8111
ColorRamp Properties . . . . . . . . . . . . . . . . . . . . 8111
Color Area Size . . . . . . . . . . . . . . . . . . . . . . 8112
Color Area Size:Height . . . . . . . . . . . . . . . 8113
Color Area Size:Width. . . . . . . . . . . . . . . . 8113
Digital Display . . . . . . . . . . . . . . . . . . . . . . 8114
RGB Value . . . . . . . . . . . . . . . . . . . . . . . . . . 8115
Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8116
NumericWithScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8116
NumericWithScale Methods . . . . . . . . . . . . . . . 8117

192 ni.com
LabVIEW Programming Reference Manual

Add Slider . . . . . . . . . . . . . . . . . . . . . . . . . . 8117


Delete Slider . . . . . . . . . . . . . . . . . . . . . . . . 8118
NumericWithScale Properties . . . . . . . . . . . . . 8118
Active Slider . . . . . . . . . . . . . . . . . . . . . . . . 8119
Digital Displays[] . . . . . . . . . . . . . . . . . . . . 8120
Housing Colors . . . . . . . . . . . . . . . . . . . . . 8121
Housing Colors:BG Color . . . . . . . . . . . . . 8122
Housing Colors:FG Color . . . . . . . . . . . . . 8122
Housing Size. . . . . . . . . . . . . . . . . . . . . . . . 8123
Housing Size:Height . . . . . . . . . . . . . . . . . 8124
Housing Size:Width . . . . . . . . . . . . . . . . . 8125
Num Of Sliders . . . . . . . . . . . . . . . . . . . . . . 8125
Show Value Tip Strip . . . . . . . . . . . . . . . . 8126
Slider Colors . . . . . . . . . . . . . . . . . . . . . . . . 8127
Slider Colors:BG Color . . . . . . . . . . . . . . . 8128
Slider Colors:FG Color . . . . . . . . . . . . . . . 8129
Text Labels Visible? . . . . . . . . . . . . . . . . . . 8130
Text Labels[] . . . . . . . . . . . . . . . . . . . . . . . . 8130
Slide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8131
Slide Properties . . . . . . . . . . . . . . . . . . . . . 8131
Fill Color . . . . . . . . . . . . . . . . . . . . . . 8132
Fill Style . . . . . . . . . . . . . . . . . . . . . . . 8133
Scale. . . . . . . . . . . . . . . . . . . . . . . . . . 8133
Knob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8134
Knob Properties . . . . . . . . . . . . . . . . . . . . 8134
Scale. . . . . . . . . . . . . . . . . . . . . . . . . . 8135
GraphChart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8135
GraphChart Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 8135
Force Redraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8136
Map Coordinates To XY . . . . . . . . . . . . . . . . . . . 8137
Map XY To Coordinates . . . . . . . . . . . . . . . . . . . 8138
GraphChart Properties . . . . . . . . . . . . . . . . . . . . . . . . 8139
Active X Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8140
Active Y Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8141
Autoscale Delay . . . . . . . . . . . . . . . . . . . . . . . . . . 8142
Frame Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8142

© National Instruments 193


LabVIEW Programming Reference Manual

Palette:Active Tool . . . . . . . . . . . . . . . . . . . . . . . 8143


Palette:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . 8144
Plot Area Bounds . . . . . . . . . . . . . . . . . . . . . . . . 8145
Plot Area:Colors. . . . . . . . . . . . . . . . . . . . . . . . . . 8146
Plot Area:Colors:BG Color . . . . . . . . . . . . . . . . . 8147
Plot Area:Colors:FG Color . . . . . . . . . . . . . . . . . 8148
Plot Area:Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8148
Plot Area:Size:Height . . . . . . . . . . . . . . . . . . . . . 8149
Plot Area:Size:Width . . . . . . . . . . . . . . . . . . . . . . 8150
Scale Legend:Visible. . . . . . . . . . . . . . . . . . . . . . 8151
Transpose Array. . . . . . . . . . . . . . . . . . . . . . . . . . 8151
X Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8152
X Scrollbar Visible . . . . . . . . . . . . . . . . . . . . . . . . 8153
Y Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8154
GraphChart Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8155
Annotation Menu Selection . . . . . . . . . . . . . . . 8155
Annotation Menu Selection? . . . . . . . . . . . . . . 8157
Autoscale Range Change . . . . . . . . . . . . . . . . . . 8158
Cursor Menu Selection. . . . . . . . . . . . . . . . . . . . 8159
Cursor Menu Selection? . . . . . . . . . . . . . . . . . . . 8160
Plot Attribute Change . . . . . . . . . . . . . . . . . . . . 8161
Scale Range Change . . . . . . . . . . . . . . . . . . . . . . 8163
WaveformChart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8164
WaveformChart Methods . . . . . . . . . . . . . . . . . 8164
Export Data to Clipboard . . . . . . . . . . . . . 8165
Export Data to DIAdem . . . . . . . . . . . . . . 8166
Export Data to Excel . . . . . . . . . . . . . . . . . 8166
Export Image . . . . . . . . . . . . . . . . . . . . . . . 8167
Export Plot Data To Clipboard . . . . . . . . 8169
Export Plot Data To DIAdem . . . . . . . . . . 8170
Export Plot Data To Excel . . . . . . . . . . . . . 8170
WaveformChart Properties . . . . . . . . . . . . . . . . 8172
Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . 8173
Digital Display(s) Visible . . . . . . . . . . . . . 8174
Digital Display[] . . . . . . . . . . . . . . . . . . . . . 8175
History Data . . . . . . . . . . . . . . . . . . . . . . . . 8176

194 ni.com
LabVIEW Programming Reference Manual

Ignore Attributes . . . . . . . . . . . . . . . . . . . . 8177


Legend:Autosize . . . . . . . . . . . . . . . . . . . . 8177
Legend:Disable . . . . . . . . . . . . . . . . . . . . . 8178
Legend:Number of Rows . . . . . . . . . . . . . 8179
Legend:Plot Minimum . . . . . . . . . . . . . . . 8180
Legend:Plot Visibility Checkbox Visible . . . . .
8181
Legend:Position . . . . . . . . . . . . . . . . . . . . 8181
Legend:Position:Left . . . . . . . . . . . . . . . . 8182
Legend:Position:Top . . . . . . . . . . . . . . . . 8183
Legend:Scroll Position . . . . . . . . . . . . . . . 8184
Legend:Scrollbar Visible . . . . . . . . . . . . . 8184
Legend:Size . . . . . . . . . . . . . . . . . . . . . . . . 8185
Legend:Size:Height . . . . . . . . . . . . . . . . . . 8186
Legend:Size:Width . . . . . . . . . . . . . . . . . . 8187
Legend:Visible . . . . . . . . . . . . . . . . . . . . . . 8187
Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8188
Stack Plots? . . . . . . . . . . . . . . . . . . . . . . . . 8189
Update Mode . . . . . . . . . . . . . . . . . . . . . . . 8189
WaveformGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8190
WaveformGraph Methods . . . . . . . . . . . . . . . . . 8191
Export Data to Clipboard . . . . . . . . . . . . . 8191
Export Data to DIAdem . . . . . . . . . . . . . . 8192
Export Data to Excel . . . . . . . . . . . . . . . . . 8193
Export Image . . . . . . . . . . . . . . . . . . . . . . . 8193
Export Plot Data To Clipboard . . . . . . . . 8195
Export Plot Data To DIAdem . . . . . . . . . . 8196
Export Plot Data To Excel . . . . . . . . . . . . . 8197
Get Plot At Position . . . . . . . . . . . . . . . . . . 8197
WaveformGraph Properties . . . . . . . . . . . . . . . 8198
Active Cursor . . . . . . . . . . . . . . . . . . . . . . . 8201
Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . 8202
Annotation List . . . . . . . . . . . . . . . . . . . . . 8203
Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8205
Cursor Legend Visible. . . . . . . . . . . . . . . . 8205
Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . 8206

© National Instruments 195


LabVIEW Programming Reference Manual

Cursors Scroll Graph. . . . . . . . . . . . . . . . . 8208


Ignore Attributes . . . . . . . . . . . . . . . . . . . . 8209
Ignore Timestamp. . . . . . . . . . . . . . . . . . . 8210
Legend:Autosize . . . . . . . . . . . . . . . . . . . . 8211
Legend:Disable . . . . . . . . . . . . . . . . . . . . . 8212
Legend:Number of Rows . . . . . . . . . . . . . 8212
Legend:Plot Minimum . . . . . . . . . . . . . . . 8213
Legend:Plot Visibility Checkbox Visible . . . . .
8214
Legend:Position . . . . . . . . . . . . . . . . . . . . 8215
Legend:Position:Left . . . . . . . . . . . . . . . . 8215
Legend:Position:Top . . . . . . . . . . . . . . . . 8216
Legend:Scroll Position . . . . . . . . . . . . . . . 8217
Legend:Scrollbar Visible . . . . . . . . . . . . . 8218
Legend:Size . . . . . . . . . . . . . . . . . . . . . . . . 8218
Legend:Size:Height . . . . . . . . . . . . . . . . . . 8219
Legend:Size:Width . . . . . . . . . . . . . . . . . . 8220
Legend:Visible . . . . . . . . . . . . . . . . . . . . . . 8220
Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8221
Plot Images:Back . . . . . . . . . . . . . . . . . . . 8222
Plot Images:Front . . . . . . . . . . . . . . . . . . . 8223
Plot Images:Middle . . . . . . . . . . . . . . . . . . 8224
Selected Cursors . . . . . . . . . . . . . . . . . . . . 8225
Smooth Update . . . . . . . . . . . . . . . . . . . . . 8225
WaveformGraph Events . . . . . . . . . . . . . . . . . . . 8226
Cursor Grab . . . . . . . . . . . . . . . . . . . . . . . . 8227
Cursor Grab? . . . . . . . . . . . . . . . . . . . . . . . 8228
Cursor Move . . . . . . . . . . . . . . . . . . . . . . . . 8229
Cursor Release . . . . . . . . . . . . . . . . . . . . . . 8231
XYGraph. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8232
XYGraph Properties . . . . . . . . . . . . . . . . . 8232
Cartesian Lines:Visible . . . . . . . . . . 8233
Optional Plane:Labels Visible. . . . 8234
Optional Plane:Lines Visible . . . . . 8234
Optional Plane:Plane Type . . . . . . 8235
DigitalGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8236

196 ni.com
LabVIEW Programming Reference Manual

DigitalGraph Properties . . . . . . . . . . . . . . 8236


Active Bus . . . . . . . . . . . . . . . . . . . . . 8237
Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . 8238
Bus Open. . . . . . . . . . . . . . . . . . . . . . 8238
Darken Compare Data . . . . . . . . . . 8239
Digital Tree View . . . . . . . . . . . . . . . 8240
Show Buses With Lines . . . . . . . . . 8240
IntensityChart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8241
IntensityChart Methods . . . . . . . . . . . . . . . . . . . 8241
Export Data to Clipboard . . . . . . . . . . . . . 8242
Export Data to Excel . . . . . . . . . . . . . . . . . 8242
IntensityChart Properties . . . . . . . . . . . . . . . . . 8243
Color Table . . . . . . . . . . . . . . . . . . . . . . . . . 8244
History Data . . . . . . . . . . . . . . . . . . . . . . . . 8245
Ignore Array . . . . . . . . . . . . . . . . . . . . . . . . 8246
Update Mode . . . . . . . . . . . . . . . . . . . . . . . 8246
Z Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8248
IntensityGraph. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8248
IntensityGraph Methods . . . . . . . . . . . . . . . . . . 8249
Export Data to Clipboard . . . . . . . . . . . . . 8249
Export Data to Excel . . . . . . . . . . . . . . . . . 8250
IntensityGraph Properties . . . . . . . . . . . . . . . . 8250
Active Cursor . . . . . . . . . . . . . . . . . . . . . . . 8251
Annotation List . . . . . . . . . . . . . . . . . . . . . 8252
Color Table . . . . . . . . . . . . . . . . . . . . . . . . . 8254
Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8255
Cursor Legend Visible. . . . . . . . . . . . . . . . 8256
Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . 8257
Cursors Scroll Graph. . . . . . . . . . . . . . . . . 8259
Ignore Array . . . . . . . . . . . . . . . . . . . . . . . . 8260
Plot Images:Front . . . . . . . . . . . . . . . . . . . 8260
Selected Cursors . . . . . . . . . . . . . . . . . . . . 8261
Smooth Update . . . . . . . . . . . . . . . . . . . . . 8262
Z Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8263
IntensityGraph Events . . . . . . . . . . . . . . . . . . . . 8264
Cursor Grab . . . . . . . . . . . . . . . . . . . . . . . . 8264

© National Instruments 197


LabVIEW Programming Reference Manual

Cursor Grab? . . . . . . . . . . . . . . . . . . . . . . . 8265


Cursor Move . . . . . . . . . . . . . . . . . . . . . . . . 8267
Cursor Release . . . . . . . . . . . . . . . . . . . . . . 8268
MixedSignalGraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8270
MixedSignalGraph Methods . . . . . . . . . . . . . . . 8270
Export Data to Clipboard . . . . . . . . . . . . . 8271
Export Data to DIAdem . . . . . . . . . . . . . . 8271
Export Data to Excel . . . . . . . . . . . . . . . . . 8272
Export Image . . . . . . . . . . . . . . . . . . . . . . . 8273
Export Plot Data To Clipboard . . . . . . . . 8274
Export Plot Data To DIAdem . . . . . . . . . . 8275
Export Plot Data To Excel . . . . . . . . . . . . . 8276
MixedSignalGraph Properties . . . . . . . . . . . . . 8276
Active Bus . . . . . . . . . . . . . . . . . . . . . . . . . . 8278
Active Cursor . . . . . . . . . . . . . . . . . . . . . . . 8279
Active Plot . . . . . . . . . . . . . . . . . . . . . . . . . . 8280
Active Plot Area . . . . . . . . . . . . . . . . . . . . . 8281
Annotation List . . . . . . . . . . . . . . . . . . . . . 8281
Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8283
Bus Open . . . . . . . . . . . . . . . . . . . . . . . . . . 8284
Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8285
Cursor Legend Visible. . . . . . . . . . . . . . . . 8286
Cursor List . . . . . . . . . . . . . . . . . . . . . . . . . . 8286
Cursors Scroll Graph. . . . . . . . . . . . . . . . . 8289
Ignore Attributes . . . . . . . . . . . . . . . . . . . . 8289
Ignore Timestamp. . . . . . . . . . . . . . . . . . . 8290
Legend:Disable . . . . . . . . . . . . . . . . . . . . . 8291
Legend:Visible . . . . . . . . . . . . . . . . . . . . . . 8292
Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8292
Plot Images:Back . . . . . . . . . . . . . . . . . . . 8293
Plot Images:Front . . . . . . . . . . . . . . . . . . . 8294
Plot Images:Middle . . . . . . . . . . . . . . . . . . 8295
Selected Cursors . . . . . . . . . . . . . . . . . . . . 8296
Show Buses With Lines . . . . . . . . . . . . . . 8297
Smooth Update . . . . . . . . . . . . . . . . . . . . . 8297
Viewport:Size . . . . . . . . . . . . . . . . . . . . . . . 8298

198 ni.com
LabVIEW Programming Reference Manual

Viewport:Size:Height . . . . . . . . . . . . . . . . 8299
Viewport:Size:Width . . . . . . . . . . . . . . . . . 8300
MixedSignalGraph Events . . . . . . . . . . . . . . . . . 8300
Cursor Grab . . . . . . . . . . . . . . . . . . . . . . . . 8301
Cursor Grab? . . . . . . . . . . . . . . . . . . . . . . . 8302
Cursor Move . . . . . . . . . . . . . . . . . . . . . . . . 8303
Cursor Release . . . . . . . . . . . . . . . . . . . . . . 8304
String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8305
String Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8305
Append String . . . . . . . . . . . . . . . . . . . . . . . . . . . 8305
Byte Offset from Point . . . . . . . . . . . . . . . . . . . . 8306
Get Nth Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8307
Size to Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8309
String Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8309
Allow Dragging . . . . . . . . . . . . . . . . . . . . . . . . . . 8311
Allow Dropping . . . . . . . . . . . . . . . . . . . . . . . . . . 8311
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8312
Display Format Visible? . . . . . . . . . . . . . . . . . . . 8313
Display Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8314
Enable Wrapping. . . . . . . . . . . . . . . . . . . . . . . . . 8314
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8315
Limit To Single Line? . . . . . . . . . . . . . . . . . . . . . 8316
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8317
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8318
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8318
Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8319
Update While Typing? . . . . . . . . . . . . . . . . . . . . 8320
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8321
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . 8321
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8322
String Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8323
Drag Starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8323
Drag Starting? . . . . . . . . . . . . . . . . . . . . . . . . . . . 8325
ComboBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8328
ComboBox Properties . . . . . . . . . . . . . . . . . . . . 8328
Allow Undefined Strings . . . . . . . . . . . . . 8329

© National Instruments 199


LabVIEW Programming Reference Manual

Case Sensitive Pop-up . . . . . . . . . . . . . . . 8330


Default Value . . . . . . . . . . . . . . . . . . . . . . . 8330
Strings And Values []. . . . . . . . . . . . . . . . . 8331
Strings [] . . . . . . . . . . . . . . . . . . . . . . . . . . . 8332
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8333
Value (Signaling) . . . . . . . . . . . . . . . . . . . . 8334
ComboBox Events. . . . . . . . . . . . . . . . . . . . . . . . 8335
Operate Menu Activation . . . . . . . . . . . . . 8335
Operate Menu Dismissed . . . . . . . . . . . . 8336
IOName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8337
IOName Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8337
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8337
Menu Button Visible . . . . . . . . . . . . . . . . . . . . . . 8338
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8339
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8340
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8340
Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8341
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8342
Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . 8342
IOName Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8343
Operate Menu Activation. . . . . . . . . . . . . . . . . . 8344
Operate Menu Dismissed . . . . . . . . . . . . . . . . . 8344
DSCTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8345
DSCTag Properties . . . . . . . . . . . . . . . . . . . . . . . 8345
Allow Undefined Tags . . . . . . . . . . . . . . . 8346
Default Value . . . . . . . . . . . . . . . . . . . . . . . 8347
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8347
Value (Signaling) . . . . . . . . . . . . . . . . . . . . 8348
DAQChannelName . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8349
DAQChannelName Properties . . . . . . . . . . . . . 8349
Allow Multiple Names . . . . . . . . . . . . . . . 8349
Allow Undefined Names . . . . . . . . . . . . . 8350
Default Value . . . . . . . . . . . . . . . . . . . . . . . 8351
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8352
Value (Signaling) . . . . . . . . . . . . . . . . . . . . 8352
VISAResourceName . . . . . . . . . . . . . . . . . . . . . . . . . . . 8353

200 ni.com
LabVIEW Programming Reference Manual

VISAResourceName Properties . . . . . . . . . . . . 8353


Allow Undefined Names . . . . . . . . . . . . . 8354
Default Value . . . . . . . . . . . . . . . . . . . . . . . 8354
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8355
Value (Signaling) . . . . . . . . . . . . . . . . . . . . 8356
IVILogicalName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8356
IVILogicalName Properties . . . . . . . . . . . . . . . . 8357
Allow Undefined Names . . . . . . . . . . . . . 8357
Default Value . . . . . . . . . . . . . . . . . . . . . . . 8358
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8358
Value (Signaling) . . . . . . . . . . . . . . . . . . . . 8359
DAQmxName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8360
DAQmxName Properties . . . . . . . . . . . . . . . . . . 8360
Allow Create New . . . . . . . . . . . . . . . . . . . 8361
Allow Multiple Names . . . . . . . . . . . . . . . 8362
Allow Undefined Names . . . . . . . . . . . . . 8363
Channel:Signal Type . . . . . . . . . . . . . . . . 8363
Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8364
Filter On Device . . . . . . . . . . . . . . . . . . . . . 8365
Include Invalid Names . . . . . . . . . . . . . . . 8366
Physical Channel:Show External . . . . . . 8367
Physical Channel:Show Internal . . . . . . 8367
Physical Channel:Signal Type . . . . . . . . 8368
Switch:Show Channels . . . . . . . . . . . . . . 8369
Switch:Show Relays . . . . . . . . . . . . . . . . . 8370
Switch:Show Topologies . . . . . . . . . . . . . 8371
Terminal:Show Advanced . . . . . . . . . . . . 8371
Terminal:Show Basic . . . . . . . . . . . . . . . . 8372
GenClassTagRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8373
GenClassTagFlatRef . . . . . . . . . . . . . . . . . . . . . . . . . . . 8373
Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8373
Cluster Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8373
Set Cluster Order . . . . . . . . . . . . . . . . . . . . . . . . . 8373
Cluster Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8374
All Objects[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8375
Auto Sizing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8375

© National Instruments 201


LabVIEW Programming Reference Manual

Cluster Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8376


Cluster Size:Height . . . . . . . . . . . . . . . . . . . . . . . 8377
Cluster Size:Width . . . . . . . . . . . . . . . . . . . . . . . . 8378
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8378
Controls[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8379
Decorations[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8380
RadioButtonsControl . . . . . . . . . . . . . . . . . . . . . . . . . . 8380
RadioButtonsControl Properties . . . . . . . . . . . 8381
Allow No Selection . . . . . . . . . . . . . . . . . . 8381
Mechanical Action. . . . . . . . . . . . . . . . . . . 8382
MulticolumnListbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8382
MulticolumnListbox Methods . . . . . . . . . . . . . . . . . . 8383
Custom Item Symbols:Get Symbol . . . . . . . . . 8384
Custom Item Symbols:Get Symbol Array . . . 8385
Custom Item Symbols:Revert All To Built In
Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8386
Custom Item Symbols:Revert To Built In
Symbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8387
Custom Item Symbols:Set To Custom Symbol . . . .
8388
Custom Item Symbols:Set To Custom Symbol
Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8389
Get Clicked Column Header . . . . . . . . . . . . . . . 8390
Get Double-Clicked Row . . . . . . . . . . . . . . . . . . 8391
Point to Row Column . . . . . . . . . . . . . . . . . . . . . 8392
MulticolumnListbox Properties . . . . . . . . . . . . . . . . . 8393
Active Cell:Active Cell . . . . . . . . . . . . . . . . . . . . . 8397
Active Cell:Cell Background Color. . . . . . . . . . 8399
Active Cell:Cell Font . . . . . . . . . . . . . . . . . . . . . . 8399
Active Cell:Cell Font:Bold . . . . . . . . . . . . . . . . . 8400
Active Cell:Cell Font:Color . . . . . . . . . . . . . . . . 8401
Active Cell:Cell Font:Italic . . . . . . . . . . . . . . . . . 8402
Active Cell:Cell Font:Name . . . . . . . . . . . . . . . . 8402
Active Cell:Cell Font:Size . . . . . . . . . . . . . . . . . . 8403
Active Cell:Cell Font:Strikeout . . . . . . . . . . . . . 8404
Active Cell:Cell Font:Underline . . . . . . . . . . . . 8405

202 ni.com
LabVIEW Programming Reference Manual

Active Cell:Cell Justification . . . . . . . . . . . . . . . 8405


Active Cell:Cell Size. . . . . . . . . . . . . . . . . . . . . . . 8406
Active Cell:Cell Size:Height . . . . . . . . . . . . . . . . 8407
Active Cell:Cell Size:Width . . . . . . . . . . . . . . . . 8407
Active Cell:Position . . . . . . . . . . . . . . . . . . . . . . . 8408
Active Cell:Position:Left . . . . . . . . . . . . . . . . . . . 8409
Active Cell:Position:Top. . . . . . . . . . . . . . . . . . . 8410
Allow Editing Cells . . . . . . . . . . . . . . . . . . . . . . . 8410
Autosizing Row Height . . . . . . . . . . . . . . . . . . . . 8411
Bulk Cells:Background Colors . . . . . . . . . . . . . 8412
Bulk Cells:Font Colors . . . . . . . . . . . . . . . . . . . . 8413
Column Header Strings[] . . . . . . . . . . . . . . . . . . 8413
Content Rect Bounds . . . . . . . . . . . . . . . . . . . . . 8414
Content Rect Bounds:Height . . . . . . . . . . . . . . 8415
Content Rect Bounds:Width . . . . . . . . . . . . . . . 8416
Content Rect Position . . . . . . . . . . . . . . . . . . . . 8416
Content Rect Position:Left . . . . . . . . . . . . . . . . 8417
Content Rect Position:Top . . . . . . . . . . . . . . . . 8418
Disabled Items . . . . . . . . . . . . . . . . . . . . . . . . . . . 8419
Drag/Drop:Allow Drag and Drop Outside
Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8420
Drag/Drop:Allow Dragging . . . . . . . . . . . . . . . . 8421
Drag/Drop:Allow Dropping . . . . . . . . . . . . . . . . 8421
Drag/Drop:Drag Mode . . . . . . . . . . . . . . . . . . . . 8422
Edit Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8423
Focus Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8424
Is Array? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8425
Item Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8426
Item Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8426
Keyboard Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 8427
Multiple Line Input . . . . . . . . . . . . . . . . . . . . . . . 8428
Number of Columns . . . . . . . . . . . . . . . . . . . . . . 8429
Number of Rows . . . . . . . . . . . . . . . . . . . . . . . . . 8430
Row Header Strings[] . . . . . . . . . . . . . . . . . . . . . 8431
Select Entire Rows . . . . . . . . . . . . . . . . . . . . . . . 8431
Selected Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8432

© National Instruments 203


LabVIEW Programming Reference Manual

Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . 8433


Selection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 8433
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8434
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8435
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8436
Smooth Horizontal Scrolling . . . . . . . . . . . . . . 8437
Top Left Visible Cell . . . . . . . . . . . . . . . . . . . . . . 8437
Visible Items:Column Headers Visible . . . . . . 8438
Visible Items:Horizontal Lines Visible. . . . . . . 8439
Visible Items:Horizontal Scrollbar Visible . . . 8440
Visible Items:Row Headers Visible . . . . . . . . . 8441
Visible Items:Symbols Visible . . . . . . . . . . . . . . 8442
Visible Items:Vertical Lines Visible . . . . . . . . . 8442
Visible Items:Vertical Scrollbar Visible . . . . . . 8443
MulticolumnListbox Events . . . . . . . . . . . . . . . . . . . . 8444
Double Click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8444
Drag Starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8446
Drag Starting? . . . . . . . . . . . . . . . . . . . . . . . . . . . 8448
Edit Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8451
Edit Cell? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8452
WaveformData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8453
PageSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8453
PageSelector Methods . . . . . . . . . . . . . . . . . . . . . . . . . 8453
Add Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8454
Duplicate Page . . . . . . . . . . . . . . . . . . . . . . . . . . . 8455
Remove Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8455
PageSelector Properties . . . . . . . . . . . . . . . . . . . . . . . 8456
Page Selector Visible . . . . . . . . . . . . . . . . . . . . . 8457
Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8458
TabControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8458
TabControl Methods. . . . . . . . . . . . . . . . . . . . . . 8458
Rearrange Pages . . . . . . . . . . . . . . . . . . . . 8459
TabControl Properties . . . . . . . . . . . . . . . . . . . . 8460
Allow Multiple Colors . . . . . . . . . . . . . . . . 8461
Allow Multiple Rows . . . . . . . . . . . . . . . . . 8462
Auto Grow? . . . . . . . . . . . . . . . . . . . . . . . . . 8462

204 ni.com
LabVIEW Programming Reference Manual

Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8463
Colors:BG Color . . . . . . . . . . . . . . . . . . . . . 8464
Colors:FG Color . . . . . . . . . . . . . . . . . . . . . 8465
Fixed Tab Dimension . . . . . . . . . . . . . . . . 8465
Fixed Tab Dimension:Height . . . . . . . . . 8467
Fixed Tab Dimension:Width . . . . . . . . . . 8467
Justify Tabs. . . . . . . . . . . . . . . . . . . . . . . . . 8468
Page Labels Display Visible? . . . . . . . . . . 8469
Tab Control Pane Dimension . . . . . . . . . 8470
Tab Control Pane Dimension:Height . . 8470
Tab Control Pane Dimension:Width . . . 8471
Tab Into . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8472
Tab Layout . . . . . . . . . . . . . . . . . . . . . . . . . 8472
Tab Location. . . . . . . . . . . . . . . . . . . . . . . . 8473
Tab Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8474
Tabs Visible? . . . . . . . . . . . . . . . . . . . . . . . . 8475
AbsTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8475
AbsTime Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 8475
Data Entry Limits . . . . . . . . . . . . . . . . . . . . . . . . 8476
Data Entry Limits:Increment . . . . . . . . . . . . . . 8477
Data Entry Limits:Maximum . . . . . . . . . . . . . . . 8478
Data Entry Limits:Minimum . . . . . . . . . . . . . . . 8479
Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8479
Numeric Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8480
Response to Value Outside Limits . . . . . . . . . . 8481
Response to Value Outside Limits:Increment. . . . .
8483
Response to Value Outside Limits:Maximum . . . . .
8484
Response to Value Outside Limits:Minimum . . . . .
8485
DigitalTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8486
DigitalTable Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 8486
Export Data to Clipboard . . . . . . . . . . . . . . . . . . 8486
Export Data to Excel . . . . . . . . . . . . . . . . . . . . . . 8487
Export Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8488

© National Instruments 205


LabVIEW Programming Reference Manual

Point to Row Column . . . . . . . . . . . . . . . . . . . . . 8489


DigitalTable Properties . . . . . . . . . . . . . . . . . . . . . . . . 8490
Active Cell:Active Cell . . . . . . . . . . . . . . . . . . . . . 8493
Active Cell:Cell Background Color. . . . . . . . . . 8494
Active Cell:Cell Foreground Color . . . . . . . . . . 8495
Active Cell:Cell Position . . . . . . . . . . . . . . . . . . . 8495
Active Cell:Cell Position:Left . . . . . . . . . . . . . . . 8496
Active Cell:Cell Position:Top . . . . . . . . . . . . . . . 8497
Cell Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8498
Cell Font:Bold . . . . . . . . . . . . . . . . . . . . . . . . . . . 8499
Cell Font:Color. . . . . . . . . . . . . . . . . . . . . . . . . . . 8500
Cell Font:Italic . . . . . . . . . . . . . . . . . . . . . . . . . . . 8500
Cell Font:Name . . . . . . . . . . . . . . . . . . . . . . . . . . 8501
Cell Font:Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8502
Cell Font:Strikeout . . . . . . . . . . . . . . . . . . . . . . . 8503
Cell Font:Underline . . . . . . . . . . . . . . . . . . . . . . 8503
Content Rect Bounds . . . . . . . . . . . . . . . . . . . . . 8504
Content Rect Bounds:Height . . . . . . . . . . . . . . 8505
Content Rect Bounds:Width . . . . . . . . . . . . . . . 8506
Content Rect Position . . . . . . . . . . . . . . . . . . . . 8506
Content Rect Position:Left . . . . . . . . . . . . . . . . 8507
Content Rect Position:Top . . . . . . . . . . . . . . . . 8508
Default Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8509
Edit Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8509
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8510
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8511
Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . 8512
Selection Size . . . . . . . . . . . . . . . . . . . . . . . . . . . 8513
Selection Start . . . . . . . . . . . . . . . . . . . . . . . . . . . 8514
Signal Numbers Visible . . . . . . . . . . . . . . . . . . . 8515
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8515
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8516
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8517
Top Left Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8518
Transitions Visible. . . . . . . . . . . . . . . . . . . . . . . . 8519
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8520

206 ni.com
LabVIEW Programming Reference Manual

Value (Signaling) . . . . . . . . . . . . . . . . . . . . . . . . . 8520


Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8521
TreeControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8522
TreeControl Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 8522
Custom Item Symbols:Get Symbol . . . . . . . . . 8524
Custom Item Symbols:Get Symbol Array . . . 8525
Custom Item Symbols:Revert All To Built In
Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8526
Custom Item Symbols:Revert To Built In
Symbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8527
Custom Item Symbols:Set To Custom Symbol . . . .
8528
Custom Item Symbols:Set To Custom Symbol
Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8529
Double Click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8531
Edit Tree Items:Add Item . . . . . . . . . . . . . . . . . . 8531
Edit Tree Items:Add Item to End . . . . . . . . . . . 8533
Edit Tree Items:Add Multiple Items to End . . 8535
Edit Tree Items:Delete Item . . . . . . . . . . . . . . . 8537
Edit Tree Items:Move Item . . . . . . . . . . . . . . . . 8538
Edit Tree Items:Set Tag . . . . . . . . . . . . . . . . . . . 8539
Edit Tree Items:Sort Children . . . . . . . . . . . . . . 8541
Navigate Tree:Get Child . . . . . . . . . . . . . . . . . . . 8542
Navigate Tree:Get Next Item . . . . . . . . . . . . . . . 8543
Navigate Tree:Get Parent Item . . . . . . . . . . . . . 8545
Navigate Tree:Get Path . . . . . . . . . . . . . . . . . . . 8546
Navigate Tree:Get Previous Item . . . . . . . . . . . 8547
Open/Close:All . . . . . . . . . . . . . . . . . . . . . . . . . . . 8548
Open/Close:Ensure Visible . . . . . . . . . . . . . . . . 8549
Open/Close:Item . . . . . . . . . . . . . . . . . . . . . . . . . 8550
Point to Row Column . . . . . . . . . . . . . . . . . . . . . 8551
TreeControl Properties . . . . . . . . . . . . . . . . . . . . . . . . 8552
Active Cell:Active Column Number . . . . . . . . . 8557
Active Cell:Background Color . . . . . . . . . . . . . 8558
Active Cell:Cell Font . . . . . . . . . . . . . . . . . . . . . . 8559
Active Cell:Cell Font:Bold . . . . . . . . . . . . . . . . . 8560

© National Instruments 207


LabVIEW Programming Reference Manual

Active Cell:Cell Font:Color . . . . . . . . . . . . . . . . 8560


Active Cell:Cell Font:Italic . . . . . . . . . . . . . . . . . 8561
Active Cell:Cell Font:Name . . . . . . . . . . . . . . . . 8562
Active Cell:Cell Font:Size . . . . . . . . . . . . . . . . . . 8563
Active Cell:Cell Font:Strikeout . . . . . . . . . . . . . 8563
Active Cell:Cell Font:Underline . . . . . . . . . . . . 8564
Active Cell:Cell Justification . . . . . . . . . . . . . . . 8565
Active Cell:Cell Size. . . . . . . . . . . . . . . . . . . . . . . 8565
Active Cell:Cell Size:Height . . . . . . . . . . . . . . . . 8566
Active Cell:Cell Size:Width . . . . . . . . . . . . . . . . 8567
Active Cell:Position . . . . . . . . . . . . . . . . . . . . . . . 8568
Active Cell:Position:Left . . . . . . . . . . . . . . . . . . . 8568
Active Cell:Position:Top. . . . . . . . . . . . . . . . . . . 8569
Active Cell:String . . . . . . . . . . . . . . . . . . . . . . . . . 8570
Active Item:Child-Only? . . . . . . . . . . . . . . . . . . . 8571
Active Item:Disabled? . . . . . . . . . . . . . . . . . . . . 8572
Active Item:Indent Level . . . . . . . . . . . . . . . . . . 8572
Active Item:Open?. . . . . . . . . . . . . . . . . . . . . . . . 8574
Active Item:Row Number . . . . . . . . . . . . . . . . . 8574
Active Item:Symbol Index . . . . . . . . . . . . . . . . . 8575
Active Item:Tag . . . . . . . . . . . . . . . . . . . . . . . . . . 8576
All Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8577
Allow Editing Cells . . . . . . . . . . . . . . . . . . . . . . . 8578
Allow Selection of Parent Items . . . . . . . . . . . . 8579
Autosizing Row Height . . . . . . . . . . . . . . . . . . . . 8580
Column Header Strings[] . . . . . . . . . . . . . . . . . . 8581
Content Rect Bounds . . . . . . . . . . . . . . . . . . . . . 8581
Content Rect Bounds:Height . . . . . . . . . . . . . . 8582
Content Rect Bounds:Width . . . . . . . . . . . . . . . 8583
Content Rect Position . . . . . . . . . . . . . . . . . . . . 8583
Content Rect Position:Left . . . . . . . . . . . . . . . . 8584
Content Rect Position:Top . . . . . . . . . . . . . . . . 8585
Displayed Items . . . . . . . . . . . . . . . . . . . . . . . . . . 8586
Drag/Drop:Allow Drag and Drop Outside
Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8586
Drag/Drop:Allow Dragging . . . . . . . . . . . . . . . . 8587

208 ni.com
LabVIEW Programming Reference Manual

Drag/Drop:Allow Dragging of Parent Items . . 8588


Drag/Drop:Allow Dropping . . . . . . . . . . . . . . . . 8589
Drag/Drop:Allow Dropping Between Items. . 8590
Drag/Drop:Drag Mode . . . . . . . . . . . . . . . . . . . . 8591
Edit Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8592
Expand/Contract Symbol:Show Symbol at Root . .
8593
Expand/Contract Symbol:Symbol Type . . . . . 8594
Focus Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8594
Is Array? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8595
Keyboard Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 8596
Multiple Line Input . . . . . . . . . . . . . . . . . . . . . . . 8597
Number of Columns . . . . . . . . . . . . . . . . . . . . . . 8598
Number of Rows . . . . . . . . . . . . . . . . . . . . . . . . . 8598
Row Header Strings[] . . . . . . . . . . . . . . . . . . . . . 8599
Select Entire Rows . . . . . . . . . . . . . . . . . . . . . . . 8600
Selection Color . . . . . . . . . . . . . . . . . . . . . . . . . . 8601
Selection Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 8601
Sibling Multiselect . . . . . . . . . . . . . . . . . . . . . . . 8602
Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8603
Size:Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8604
Size:Width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8605
Top Left Visible Cell . . . . . . . . . . . . . . . . . . . . . . 8605
Visible Items:Column Headers Visible . . . . . . 8607
Visible Items:Hierarchy Lines Visible . . . . . . . 8607
Visible Items:Horizontal Lines Visible. . . . . . . 8608
Visible Items:Horizontal Scrollbar Visible . . . 8609
Visible Items:Row Headers Visible . . . . . . . . . 8610
Visible Items:Symbols Visible . . . . . . . . . . . . . . 8611
Visible Items:Vertical Lines Visible . . . . . . . . . 8612
Visible Items:Vertical Scrollbar Visible . . . . . . 8612
TreeControl Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8613
Double Click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8614
Drag Starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8616
Drag Starting? . . . . . . . . . . . . . . . . . . . . . . . . . . . 8618
Edit Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8621

© National Instruments 209


LabVIEW Programming Reference Manual

Edit Cell? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8622


Item Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8623
Item Close? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8624
Item Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8625
Item Open? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8626
SubPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8627
SubPanel Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8627
Insert VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8627
InsertBlockDiagram . . . . . . . . . . . . . . . . . . . . . . 8629
Remove VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8630
SubPanel Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 8630
Allow User to Open Diagram . . . . . . . . . . . . . . 8631
Container Bounds . . . . . . . . . . . . . . . . . . . . . . . . 8632
Container Bounds:Height . . . . . . . . . . . . . . . . . 8633
Container Bounds:Width . . . . . . . . . . . . . . . . . . 8633
Diagram Inserted . . . . . . . . . . . . . . . . . . . . . . . . 8634
Inserted VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8635
Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8635
Panel Transparent. . . . . . . . . . . . . . . . . . . . . . . . 8636
PlugInControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8637
PlugInDDODummyContainer . . . . . . . . . . . . . . . . . . . . . . . . 8637
Pixmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8637
Scrollbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8637
Scrollbar Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 8637
Coerce Maximum Value . . . . . . . . . . . . . . . . . . . 8638
Coerce Minimum Value . . . . . . . . . . . . . . . . . . . 8639
Doc Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8640
Doc Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8641
Housing Length . . . . . . . . . . . . . . . . . . . . . . . . . . 8642
Increment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8643
Page Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8644
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . 8645
SceneGraphDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8646
SceneGraphDisplay Methods . . . . . . . . . . . . . . . . . . . 8646
AutoFocus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8647
Pick Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8647

210 ni.com
LabVIEW Programming Reference Manual

PickPoint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8648
Projection:Frustum . . . . . . . . . . . . . . . . . . . . . . 8649
Projection:Orthographic . . . . . . . . . . . . . . . . . . 8651
Projection:Perspective . . . . . . . . . . . . . . . . . . . 8652
Redraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8654
Render to Image . . . . . . . . . . . . . . . . . . . . . . . . . 8654
Setup Camera . . . . . . . . . . . . . . . . . . . . . . . . . . . 8655
WindowToObjectCoords . . . . . . . . . . . . . . . . . . 8656
SceneGraphDisplay Properties . . . . . . . . . . . . . . . . . 8657
Automatic Projection Mode . . . . . . . . . . . . . . . 8658
Background Color . . . . . . . . . . . . . . . . . . . . . . . . 8659
Camera Controller:Auto Redraw . . . . . . . . . . . 8660
Camera Controller:Type . . . . . . . . . . . . . . . . . . 8661
Content Bounds . . . . . . . . . . . . . . . . . . . . . . . . . 8661
Content Bounds:Height . . . . . . . . . . . . . . . . . . . 8662
Content Bounds:Width . . . . . . . . . . . . . . . . . . . 8663
Content Position . . . . . . . . . . . . . . . . . . . . . . . . . 8663
Content Position:Horizontal. . . . . . . . . . . . . . . 8664
Content Position:Vertical . . . . . . . . . . . . . . . . . 8665
ModelView Matrix . . . . . . . . . . . . . . . . . . . . . . . . 8666
Projection Matrix. . . . . . . . . . . . . . . . . . . . . . . . . 8666
LabVIEWClassControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8667
LabVIEWClassControl Methods . . . . . . . . . . . . . . . . . 8667
ReplaceWithControlOfOtherClass. . . . . . . . . . 8668
LabVIEWClassControl Properties . . . . . . . . . . . . . . . 8668
LabVIEW Class Name . . . . . . . . . . . . . . . . . . . . . 8669
Qualified Name . . . . . . . . . . . . . . . . . . . . . . . . . . 8669
MixedCheckbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8670
MixedCheckbox Properties . . . . . . . . . . . . . . . . . . . . . 8670
Allow Mixed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8671
Button Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8672
Button Size:Height . . . . . . . . . . . . . . . . . . . . . . . 8672
Button Size:Width . . . . . . . . . . . . . . . . . . . . . . . . 8673
Strings [] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8674
Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8675
Toggle Key Binding . . . . . . . . . . . . . . . . . . . . . . . 8676

© National Instruments 211


LabVIEW Programming Reference Manual

MultiSegmentPipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8678
MultiSegmentPipe Properties . . . . . . . . . . . . . . . . . . 8679
Colors [2]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8679
Flange 1:Depth . . . . . . . . . . . . . . . . . . . . . . . . . . 8680
Flange 1:Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 8681
Flange 2:Depth . . . . . . . . . . . . . . . . . . . . . . . . . . 8683
Flange 2:Width . . . . . . . . . . . . . . . . . . . . . . . . . . . 8684
Pipe Radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8685
StubDDO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8686
Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8686
Set Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8687
Scroll to Element . . . . . . . . . . . . . . . . . . . . . . . . 8687
Set Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8688
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8688
Number of Visible Elements . . . . . . . . . . . . . . . 8689
Set Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8690
Top Visible Element . . . . . . . . . . . . . . . . . . . . . . 8690
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8691
Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8692
Map Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8692
Scroll To Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8692
Map Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8693
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8693
Map Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8694
Map Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8695
Number of Visible Key Value Pairs. . . . . . . . . . 8695
Top Visible KeyValue Pair . . . . . . . . . . . . . . . . . 8696
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8697
Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8697
Panel Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8698
Align Selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8698
Clear Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8699
Convert Panel To Screen Coordinates . . . . . . . . . . . 8700
Convert Screen To Panel Coordinates . . . . . . . . . . . 8701
Copy Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8702
Distribute Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . 8702

212 ni.com
LabVIEW Programming Reference Manual

Make Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8703


Move Selection Backward. . . . . . . . . . . . . . . . . . . . . . 8704
Move Selection Forward . . . . . . . . . . . . . . . . . . . . . . . 8705
Move Selection To Back. . . . . . . . . . . . . . . . . . . . . . . . 8705
Move Selection To Front . . . . . . . . . . . . . . . . . . . . . . . 8706
Select All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8706
Panel Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8707
All Objects[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8707
Controls[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8708
Decorations[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8709
Defer Panel Updates. . . . . . . . . . . . . . . . . . . . . . . . . . . 8709
Panes[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8710
Selection List[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8711
Splitters[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8712
Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8712
Pane Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8712
Convert Pane To Panel Coordinates . . . . . . . . . . . . . 8713
Convert Panel To Pane Coordinates . . . . . . . . . . . . . 8715
Get Scaling Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8716
Group Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8717
Lock Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8718
Make Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8718
Paste Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8719
Select All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8720
Set Scaling Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8720
Ungroup Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8722
Unlock Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8722
Pane Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8723
Background Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8724
Background Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8727
Content Area Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8727
Horizontal Scrollbar Visibility . . . . . . . . . . . . . . . . . . 8728
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8729
Minimum Pane Size . . . . . . . . . . . . . . . . . . . . . . . . . . . 8730
Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8730
Pane Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8731

© National Instruments 213


LabVIEW Programming Reference Manual

Scroll To Origin At Run Time. . . . . . . . . . . . . . . . . . . . 8732


Vertical Scrollbar Visibility . . . . . . . . . . . . . . . . . . . . . 8733
Z-Order:All Objects[] . . . . . . . . . . . . . . . . . . . . . . . . . . 8733
Z-Order:Controls[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8734
Z-Order:Decorations[] . . . . . . . . . . . . . . . . . . . . . . . . . 8735
Pane Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8735
Mouse Down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8736
Mouse Down? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8737
Mouse Enter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8739
Mouse Leave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8739
Mouse Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8740
Mouse Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8741
Mouse Wheel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8742
Pane Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8744
Shortcut Menu Activation? . . . . . . . . . . . . . . . . . . . . . 8745
Shortcut Menu Selection (User) . . . . . . . . . . . . . . . . 8746
Splitter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8747
Splitter Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8747
Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8748
Colors:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8749
Colors:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8750
Is Vertical? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8750
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8751
Sizing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8751
Splitter Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8752
Splitter Position Locked . . . . . . . . . . . . . . . . . . . . . . . 8753
Splitter Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8754
Mouse Down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8754
Mouse Down? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8755
Mouse Enter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8757
Mouse Leave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8758
Mouse Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8758
Mouse Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8759
Mouse Wheel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8760
AbstractDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8762
AbstractDiagram Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 8762

214 ni.com
LabVIEW Programming Reference Manual

Make Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8763


Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8764
Remove Wire Loose Ends . . . . . . . . . . . . . . . . . . . . . . 8764
Select All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8765
Shrink Wrap Structures . . . . . . . . . . . . . . . . . . . . . . . . 8766
AbstractDiagram Properties . . . . . . . . . . . . . . . . . . . . . . . . . 8766
All Objects[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8767
Breakpoint Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8767
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8768
Decorations[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8769
Firing Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8769
Nodes[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8770
SubVIs[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8770
Subdiagram Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8771
Wires[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8772
Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8772
Diagram Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8772
Clean Up Diagram . . . . . . . . . . . . . . . . . . . . . . . . 8773
Create from Data Type . . . . . . . . . . . . . . . . . . . . 8774
Default Diagram Clean Up Options . . . . . . . . . 8775
Diagram Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 8776
Visible Bounds . . . . . . . . . . . . . . . . . . . . . . . . . . . 8776
TopLevelDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8777
TopLevelDiagram Methods . . . . . . . . . . . . . . . . 8777
Align Selection . . . . . . . . . . . . . . . . . . . . . . 8778
Clear Selection . . . . . . . . . . . . . . . . . . . . . 8779
Copy Selection. . . . . . . . . . . . . . . . . . . . . . 8780
Cut Selection . . . . . . . . . . . . . . . . . . . . . . . 8780
Distribute Selection . . . . . . . . . . . . . . . . . 8781
Enclose Selection 2. . . . . . . . . . . . . . . . . . 8782
External Editor Wizard . . . . . . . . . . . . . . . 8783
Make Selection . . . . . . . . . . . . . . . . . . . . . 8784
Make Selection From Rect. . . . . . . . . . . . 8785
Move Selected Objects. . . . . . . . . . . . . . . 8786
Move Selection Backward . . . . . . . . . . . . 8787
Move Selection Forward . . . . . . . . . . . . . 8788

© National Instruments 215


LabVIEW Programming Reference Manual

Move Selection To Back . . . . . . . . . . . . . . 8788


Move Selection To Front . . . . . . . . . . . . . 8789
RemoveFromSelection . . . . . . . . . . . . . . 8790
TopLevelDiagram Properties . . . . . . . . . . . . . . 8790
Button Bar Visible . . . . . . . . . . . . . . . . . . . 8791
Execution Highlighted Object . . . . . . . . 8792
Highlight Execution? . . . . . . . . . . . . . . . . 8792
Menubar Visible . . . . . . . . . . . . . . . . . . . . . 8793
Selection List[] . . . . . . . . . . . . . . . . . . . . . . 8794
SimDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8794
SimDiagram Properties . . . . . . . . . . . . . . . . . . . 8794
CompanionDiag . . . . . . . . . . . . . . . . . . . . 8795
SimulationParameters . . . . . . . . . . . . . . . 8796
CompanionDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . 8796
CompanionDiagram Properties . . . . . . . . . . . . 8797
SimulationDiagram . . . . . . . . . . . . . . . . . 8797
SDF Companion Diagram . . . . . . . . . . . . . . . . . . . . . . 8798
SDFDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8798
ScDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8798
MathDiagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8798
Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8798
Terminal Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8798
Connect Wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8799
Create Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8800
Create Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8801
Create Described Wire . . . . . . . . . . . . . . . . . . . . . . . . . 8801
Create Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8803
Create Shared Variable Node . . . . . . . . . . . . . . . . . . . 8803
Terminal Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8804
Caption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8805
Coercion Dot? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8805
Connected Wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8806
Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8807
Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8807
Is Hidden? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8808
Is Source? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8808

216 ni.com
LabVIEW Programming Reference Manual

Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8809
ControlTerminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8810
ControlTerminal Methods . . . . . . . . . . . . . . . . . . . . . . 8810
Change To Constant . . . . . . . . . . . . . . . . . . . . . . 8810
Change to Shared Variable Node . . . . . . . . . . 8811
Toggle Direction . . . . . . . . . . . . . . . . . . . . . . . . . 8812
ControlTerminal Properties . . . . . . . . . . . . . . . . . . . . 8812
Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8813
Icon View? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8814
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8814
InnerTerminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8815
InnerTerminal Properties . . . . . . . . . . . . . . . . . . . . . . 8815
Tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8815
OuterTerminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8816
OuterTerminal Properties . . . . . . . . . . . . . . . . . . . . . . 8816
Tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8816
ParameterTerminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8817
ParameterTerminal Properties . . . . . . . . . . . . . . . . . 8817
Wiring Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8817
OverridableParameterTerminal . . . . . . . . . . . . . . . . 8818
OverridableParameterTerminal Properties . 8818
Fixed-Point:Maximum Word Length . . . 8820
Fixed-Point:Overflow Policy . . . . . . . . . . 8821
Fixed-Point:Quantization Policy . . . . . . 8821
Fixed-Point:Representation:Actual . . . . 8822
Fixed-Point:Representation:Actual:Delta . . .
8823
Fixed-Point:Representation:Actual:Range
Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8823
Fixed-Point:Representation:Actual:Range
Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8824
Fixed-Point:Representation:Bits . . . . . . 8825
Fixed-Point:Representation:Bits:Integer
Word Length . . . . . . . . . . . . . . . . . . . . . . . . 8826
Fixed-Point:Representation:Bits:Signed . . . .
8826

© National Instruments 217


LabVIEW Programming Reference Manual

Fixed-Point:Representation:Bits:Word
Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8827
Fixed-Point:Representation:Desired . . 8828
Fixed-Point:Representation:Desired:Delta . .
8829
Fixed-Point:Representation:Desired:Range
Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8829
Fixed-Point:Representation:Desired:Range
Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8830
Fixed-Point:Representation:Include
Overflow Status Policy . . . . . . . . . . . . . . . 8831
Numeric Override Policy . . . . . . . . . . . . . 8832
Numeric Override Representation . . . . 8832
Representation . . . . . . . . . . . . . . . . . . . . . 8833
Uses Fixed-Point Overflow and
Quantization . . . . . . . . . . . . . . . . . . . . . . . 8834
Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8834
Constant Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8834
Change to Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8835
Change to Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . 8836
Change to Shared Variable Node . . . . . . . . . . . . . . . 8836
Copy Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8837
Disconnect From Typedef . . . . . . . . . . . . . . . . . . . . . . 8838
Paste Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8838
Update From Typedef . . . . . . . . . . . . . . . . . . . . . . . . . 8839
Constant Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8840
Auto-Update From Typedef . . . . . . . . . . . . . . . . . . . . 8840
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8841
Is Typedef? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8842
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8842
Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8843
Tip Strip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8843
Typedef:Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8844
Typedef:VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8845
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8845
PathConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8846

218 ni.com
LabVIEW Programming Reference Manual

PathConstant Properties . . . . . . . . . . . . . . . . . . . . . . . 8846


Path Too Long To Fit . . . . . . . . . . . . . . . . . . . . . . 8847
Path Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8847
Scrollbar Visible?. . . . . . . . . . . . . . . . . . . . . . . . . 8848
Shows Abbreviated Behavior? . . . . . . . . . . . . . 8849
Size To Text? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8850
ArrayConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8850
ArrayConstant Methods . . . . . . . . . . . . . . . . . . . . . . . . 8850
Delete Column . . . . . . . . . . . . . . . . . . . . . . . . . . . 8851
Delete Element . . . . . . . . . . . . . . . . . . . . . . . . . . 8852
Delete Row . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8853
Empty Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8854
Insert Column Before . . . . . . . . . . . . . . . . . . . . . 8854
Insert Element Before . . . . . . . . . . . . . . . . . . . . 8855
Insert Row Before . . . . . . . . . . . . . . . . . . . . . . . . 8856
ArrayConstant Properties . . . . . . . . . . . . . . . . . . . . . . 8857
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8858
Element Gap?. . . . . . . . . . . . . . . . . . . . . . . . . . . . 8859
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8859
Index Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8860
Index Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8861
Index Visible? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8861
Num Dimensions. . . . . . . . . . . . . . . . . . . . . . . . . 8862
Number of Columns . . . . . . . . . . . . . . . . . . . . . . 8863
Number of Rows . . . . . . . . . . . . . . . . . . . . . . . . . 8863
Selection End[] . . . . . . . . . . . . . . . . . . . . . . . . . . 8864
Selection Start[] . . . . . . . . . . . . . . . . . . . . . . . . . 8865
Show Selection? . . . . . . . . . . . . . . . . . . . . . . . . . 8865
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8866
NumericConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8867
NumericConstant Properties . . . . . . . . . . . . . . . . . . . 8867
Adapt To Entered Data . . . . . . . . . . . . . . . . . . . . 8868
Fixed-Point Overflow Status Visible? . . . . . . . 8869
Fixed-Point Representation:Actual . . . . . . . . . 8870
Fixed-Point Representation:Actual:Delta . . . 8870
Fixed-Point Representation:Actual:Range Max . . .

© National Instruments 219


LabVIEW Programming Reference Manual

8871
Fixed-Point Representation:Actual:Range Min. . . .
8872
Fixed-Point Representation:Bits . . . . . . . . . . . 8873
Fixed-Point Representation:Bits:Integer Word
Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8873
Fixed-Point Representation:Bits:Signed . . . . 8874
Fixed-Point Representation:Bits:Word Length . . . .
8875
Fixed-Point Representation:Desired. . . . . . . . 8876
Fixed-Point Representation:Desired:Delta . . 8876
Fixed-Point Representation:Desired:Range Max . .
8877
Fixed-Point Representation:Desired:Range Min . .
8878
Fixed-Point Representation:Include Overflow
Status? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8879
Representation . . . . . . . . . . . . . . . . . . . . . . . . . . 8879
DigitalNumericConstant . . . . . . . . . . . . . . . . . . . . . . . 8880
DigitalNumericConstant Properties . . . . . . . . 8880
Display Format . . . . . . . . . . . . . . . . . . . . . 8881
Display Format:Format . . . . . . . . . . . . . . 8882
Display Format:Precision . . . . . . . . . . . . 8882
Format String . . . . . . . . . . . . . . . . . . . . . . . 8883
Numeric Text . . . . . . . . . . . . . . . . . . . . . . . 8884
Radix Visible? . . . . . . . . . . . . . . . . . . . . . . . 8884
Unit Label . . . . . . . . . . . . . . . . . . . . . . . . . . 8885
NamedNumericConstant . . . . . . . . . . . . . . . . . . . . . . 8886
NamedNumericConstant Properties . . . . . . . 8886
Digital Display . . . . . . . . . . . . . . . . . . . . . . 8886
Items[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8887
RingConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8887
RingConstant Properties . . . . . . . . . . . . . 8888
Allow Undef Values? . . . . . . . . . . . . 8888
Strings And Values [] . . . . . . . . . . . . 8889
EnumConstant. . . . . . . . . . . . . . . . . . . . . . . . . . . 8889

220 ni.com
LabVIEW Programming Reference Manual

StringConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8890
StringConstant Properties . . . . . . . . . . . . . . . . . . . . . 8890
Display Format Visible? . . . . . . . . . . . . . . . . . . . 8890
Display Style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8891
Limit To Single Line? . . . . . . . . . . . . . . . . . . . . . 8892
Scrollbar Visible?. . . . . . . . . . . . . . . . . . . . . . . . . 8892
Size To Text? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8893
Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8894
ComboBoxConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . 8894
ComboBoxConstant Properties . . . . . . . . . . . . 8894
Strings And Values []. . . . . . . . . . . . . . . . . 8895
Strings [] . . . . . . . . . . . . . . . . . . . . . . . . . . . 8896
ClusterConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8896
ClusterConstant Methods . . . . . . . . . . . . . . . . . . . . . . 8897
Auto Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8897
ReorderElements . . . . . . . . . . . . . . . . . . . . . . . . 8898
ClusterConstant Properties . . . . . . . . . . . . . . . . . . . . 8898
Auto Sizing Style . . . . . . . . . . . . . . . . . . . . . . . . . 8899
Elements[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8900
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8900
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8901
View As Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8902
FixedConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8902
FixedConstant Properties . . . . . . . . . . . . . . . . . . . . . . 8902
Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8903
BooleanConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8903
IONameConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8903
IONameConstant Properties . . . . . . . . . . . . . . . . . . . 8903
Menu Button Visible . . . . . . . . . . . . . . . . . . . . . . 8904
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8905
DSCTagConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8905
DAQChannelNameConstant . . . . . . . . . . . . . . . . . . . . 8905
VISAResourceNameConstant . . . . . . . . . . . . . . . . . . . 8905
IVILogicalNameConstant . . . . . . . . . . . . . . . . . . . . . . 8905
DAQmxNameConstant . . . . . . . . . . . . . . . . . . . . . . . . . 8906
DAQmxNameConstant Properties. . . . . . . . . . 8906

© National Instruments 221


LabVIEW Programming Reference Manual

Allow Create New . . . . . . . . . . . . . . . . . . . 8907


Allow Multiple Names . . . . . . . . . . . . . . . 8908
Allow Undefined Names . . . . . . . . . . . . . 8909
Channel:Signal Type . . . . . . . . . . . . . . . . 8909
Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8910
Filter On Device . . . . . . . . . . . . . . . . . . . . . 8911
Include Invalid Names . . . . . . . . . . . . . . . 8912
Physical Channel:Show External . . . . . . 8913
Physical Channel:Show Internal . . . . . . 8913
Physical Channel:Signal Type . . . . . . . . 8914
Switch:Show Channels . . . . . . . . . . . . . . 8915
Switch:Show Relays . . . . . . . . . . . . . . . . . 8916
Switch:Show Topologies . . . . . . . . . . . . . 8917
Terminal:Show Advanced . . . . . . . . . . . . 8917
Terminal:Show Basic . . . . . . . . . . . . . . . . 8918
GenClassTagRefConstant . . . . . . . . . . . . . . . . . . . . . . 8919
GenClassTagFlatRefConstant . . . . . . . . . . . . . . . . . . . 8919
ColorBoxConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8919
AbsTimeConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8919
AbsTimeConstant Properties . . . . . . . . . . . . . . . . . . . 8919
Format String . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8919
Numeric Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8920
RefNumConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8921
RefNumConstant Properties . . . . . . . . . . . . . . . . . . . 8921
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8921
ClassSpecifierConstant . . . . . . . . . . . . . . . . . . . . . . . . 8922
ClassSpecifierConstant Methods. . . . . . . . . . . 8922
Set Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 8922
ClassSpecifierConstant Properties . . . . . . . . . 8923
All Types[] . . . . . . . . . . . . . . . . . . . . . . . . . . 8924
Class Name . . . . . . . . . . . . . . . . . . . . . . . . . 8925
Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . 8925
Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8926
GenClassRefConst . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8927
GenClassRefConst Properties . . . . . . . . . . . . . 8927
Type Class . . . . . . . . . . . . . . . . . . . . . . . . . . 8927

222 ni.com
LabVIEW Programming Reference Manual

TypedRefNumConstant . . . . . . . . . . . . . . . . . . . . . . . . 8928
TypedRefNumConstant Properties . . . . . . . . . 8928
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8928
DataValRefNumConstant . . . . . . . . . . . . . . . . . 8929
DataValRefNumConstant Properties . . 8929
Is External . . . . . . . . . . . . . . . . . . . . . 8929
LabVIEWClassConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8930
SetConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8930
SetConstant Methods . . . . . . . . . . . . . . . . . . . . . . . . . 8930
Scroll To Element . . . . . . . . . . . . . . . . . . . . . . . . 8930
SetConstant Properties . . . . . . . . . . . . . . . . . . . . . . . . 8931
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8932
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8933
Number of Visible Elements . . . . . . . . . . . . . . . 8933
Top Visible Element . . . . . . . . . . . . . . . . . . . . . . 8934
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8935
MapConstant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8935
MapConstant Methods . . . . . . . . . . . . . . . . . . . . . . . . 8935
Scroll To Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8936
MapConstant Properties . . . . . . . . . . . . . . . . . . . . . . . 8937
Horizontal Scrollbar Visible . . . . . . . . . . . . . . . 8937
Map Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8938
Map Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8938
Number of Visible Key Value Pairs. . . . . . . . . . 8939
Top Visible KeyValue Pair . . . . . . . . . . . . . . . . . 8940
Vertical Scrollbar Visible . . . . . . . . . . . . . . . . . . 8940
FormulaParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8941
FormulaParameter Properties . . . . . . . . . . . . . . . . . . . . . . . 8941
Input? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8941
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8942
Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8943
ScriptNodeParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8943
ScriptNodeParameter Properties . . . . . . . . . . . . . . . 8943
Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8944
MathScriptNodeParameter . . . . . . . . . . . . . . . . . . . . . . . . . 8944
MathScriptNodeParameter Properties . . . . . . . . . . 8944

© National Instruments 223


LabVIEW Programming Reference Manual

Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8945
Tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8945
Tunnel Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8945
Inside Terminals[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8946
Outside Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8946
LoopTunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8947
LoopTunnel Properties . . . . . . . . . . . . . . . . . . . . . . . . 8947
Condition Terminal. . . . . . . . . . . . . . . . . . . . . . . 8947
Index Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8948
Is Conditional? . . . . . . . . . . . . . . . . . . . . . . . . . . . 8949
RightShiftRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8949
RightShiftRegister Properties. . . . . . . . . . . . . . . . . . . 8950
Is An Error Register . . . . . . . . . . . . . . . . . . . . . . . 8950
Left Registers[] . . . . . . . . . . . . . . . . . . . . . . . . . . . 8951
LeftShiftRegister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8951
LeftShiftRegister Methods . . . . . . . . . . . . . . . . . . . . . . 8951
Add Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8952
LeftShiftRegister Properties . . . . . . . . . . . . . . . . . . . . 8952
Is An Error Register . . . . . . . . . . . . . . . . . . . . . . . 8953
Right Shift Register . . . . . . . . . . . . . . . . . . . . . . . 8953
ConditionalTunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8954
ConditionalTunnel Methods. . . . . . . . . . . . . . . . . . . . 8954
Clear Linked Input Tunnel . . . . . . . . . . . . . . . . . 8955
Link Input Tunnel . . . . . . . . . . . . . . . . . . . . . . . . 8955
Link Input Tunnel And Wire . . . . . . . . . . . . . . . 8956
Replace With Case Selector . . . . . . . . . . . . . . . 8957
ConditionalTunnel Properties . . . . . . . . . . . . . . . . . . 8958
Linked Input Tunnel . . . . . . . . . . . . . . . . . . . . . . 8958
Use Default if Unwired . . . . . . . . . . . . . . . . . . . . 8959
SelectorTunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8960
RegionTunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8960
SequenceLocal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8960
SequenceLocal Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 8960
Terminals[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8960
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8961
Node Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8961

224 ni.com
LabVIEW Programming Reference Manual

Connect Wires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8961


Get Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8963
Node Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8965
Breakpoint Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8965
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8966
Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8966
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8967
Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8968
Terminals[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8968
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8969
Global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8969
Global Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8970
Relink To VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8970
Global Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8970
Control Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 8971
VI Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8971
Write?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8972
Local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8973
Local Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8973
Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8973
Control Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 8974
Write?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8975
Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8975
Function Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 8975
Has Side Effects? . . . . . . . . . . . . . . . . . . . . . . . . . 8976
Terminals Visible? . . . . . . . . . . . . . . . . . . . . . . . . 8976
Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8977
Comparison Properties . . . . . . . . . . . . . . . . . . . 8977
Compare Aggregates? . . . . . . . . . . . . . . . 8978
InRangeAndCoerce . . . . . . . . . . . . . . . . . . . . . . . 8978
InRangeAndCoerce Properties . . . . . . . . 8979
Include Lower Limit? . . . . . . . . . . . 8979
Include Upper Limit? . . . . . . . . . . . 8980
ReadWriteFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8980
ReadWriteFile Properties . . . . . . . . . . . . . . . . . 8980
Convert 4.x data? . . . . . . . . . . . . . . . . . . . 8981

© National Instruments 225


LabVIEW Programming Reference Manual

TypeCast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8981
TypeCast Properties . . . . . . . . . . . . . . . . . . . . . . 8982
Convert 4.x data? . . . . . . . . . . . . . . . . . . . 8982
FlattenUnflattenString. . . . . . . . . . . . . . . . . . . . . . . . . 8982
FlattenUnflattenString Properties . . . . . . . . . 8983
Convert 4.x data? . . . . . . . . . . . . . . . . . . . 8983
FlattenString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8984
FlattenString Properties . . . . . . . . . . . . . 8984
Expose Typedefs . . . . . . . . . . . . . . . 8984
GPIBReadWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8985
GPIBReadWrite Properties . . . . . . . . . . . . . . . . 8985
Synchronous I/O? . . . . . . . . . . . . . . . . . . . 8985
ArrayToCluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8986
ArrayToCluster Properties . . . . . . . . . . . . . . . . . 8986
Cluster Size . . . . . . . . . . . . . . . . . . . . . . . . . 8986
FileDialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8987
SubVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8987
SubVI Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8987
Inline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8987
Relink To VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8989
SubVI Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8989
Bad SubVI Linkage . . . . . . . . . . . . . . . . . . . . . . . 8990
Grow Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8991
Missing VI Name . . . . . . . . . . . . . . . . . . . . . . . . . 8992
Missing VI Path . . . . . . . . . . . . . . . . . . . . . . . . . . . 8993
Skip Subroutine Call If Busy . . . . . . . . . . . . . . . 8993
SubVI Setup:Close Front Panel After Call . . . . 8994
SubVI Setup:Open Front Panel When Loaded . . . .
8995
SubVI Setup:Show Front Panel When Called . . . . .
8996
SubVI Setup:Suspend When Called . . . . . . . . 8996
Terminals Visible? . . . . . . . . . . . . . . . . . . . . . . . . 8997
VI Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8998
VI Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8998
VI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8999

226 ni.com
LabVIEW Programming Reference Manual

View As Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9000


PolymorphicSubVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9000
PolymorphicSubVI Properties . . . . . . . . . . . . . 9000
Automatic . . . . . . . . . . . . . . . . . . . . . . . . . . 9001
Polymorphic VI . . . . . . . . . . . . . . . . . . . . . 9002
Selected Type . . . . . . . . . . . . . . . . . . . . . . 9002
Selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9003
Selector Visible . . . . . . . . . . . . . . . . . . . . . 9004
ConfNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9004
AbstractDynamicDispatch . . . . . . . . . . . . . . . . . . . . . 9005
DynamicDispatchSubVI . . . . . . . . . . . . . . . . . . . 9005
CallParentNode . . . . . . . . . . . . . . . . . . . . . . . . . . 9005
GenericSubVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9005
CallByRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9005
CallByRef Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9005
Convert:Call By Reference . . . . . . . . . . . . . . . . 9006
Convert:Start Asynchronous Call . . . . . . . . . . 9006
Convert:Wait On Asynchronous Call. . . . . . . . 9007
CallByRef Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 9008
Call By Ref Node Style . . . . . . . . . . . . . . . . . . . . 9008
UnitCast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9009
UnitCast Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 9009
Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9009
Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9010
Structure Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9010
Auto Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9011
Remove Structure . . . . . . . . . . . . . . . . . . . . . . . . 9011
Shared Clones:Allocate as Needed . . . . . . . . . 9012
Shared Clones:Pre-Allocate . . . . . . . . . . . . . . . 9013
Structure Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . 9013
AutoSize To Fit Contents? . . . . . . . . . . . . . . . . . 9014
Content Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9015
Diagrams[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9015
Fix Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9016
Frame Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9017
Shared Clones:Automatic Allocation Strategy

© National Instruments 227


LabVIEW Programming Reference Manual

Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9018
Shared Clones:Pre-Allocate . . . . . . . . . . . . . . . 9018
Subdiagram Label Visible . . . . . . . . . . . . . . . . . 9019
Tunnels[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9020
Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9020
Loop Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . 9021
Add Shift Register . . . . . . . . . . . . . . . . . . . 9021
Loop Properties. . . . . . . . . . . . . . . . . . . . . . . . . . 9022
Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9022
Loop Counter . . . . . . . . . . . . . . . . . . . . . . . 9023
Shift Registers[] . . . . . . . . . . . . . . . . . . . . . 9024
ForLoop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9024
ForLoop Properties. . . . . . . . . . . . . . . . . . 9024
Chunk Size Tunnel . . . . . . . . . . . . . 9026
Dynamic Parallel Instances Tunnel . . . .
9026
Has Conditional Terminal? . . . . . . 9027
Is Debugging Allowed. . . . . . . . . . . 9028
Is Parallelism Enabled? . . . . . . . . . 9029
Iteration Terminal Hidden? . . . . . . 9029
Loop Count . . . . . . . . . . . . . . . . . . . . 9030
Loop End Ref . . . . . . . . . . . . . . . . . . 9031
Number of Static Parallel Instances . . .
9031
Parallel Schedule . . . . . . . . . . . . . . 9032
Stop If True? . . . . . . . . . . . . . . . . . . . 9033
WhileLoop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9033
WhileLoop Methods . . . . . . . . . . . . . . . . . 9034
Replace With TimeLoop . . . . . . . . . 9034
WhileLoop Properties . . . . . . . . . . . . . . . 9035
Iteration Terminal Hidden? . . . . . . 9035
Loop End Ref . . . . . . . . . . . . . . . . . . 9036
Stop If True? . . . . . . . . . . . . . . . . . . . 9036
TimedLoop . . . . . . . . . . . . . . . . . . . . . . . . . 9037
TimedLoop Methods . . . . . . . . . . . 9037
Replace With TimedSequence . . .

228 ni.com
LabVIEW Programming Reference Manual

9038
Replace With WhileLoop . . . 9038
MultiFrameStructure . . . . . . . . . . . . . . . . . . . . . . . . . . 9039
MultiFrameStructure Methods . . . . . . . . . . . . . 9039
Add Frame . . . . . . . . . . . . . . . . . . . . . . . . . 9040
Duplicate Frame . . . . . . . . . . . . . . . . . . . . 9041
Rearrange Frames . . . . . . . . . . . . . . . . . . . 9041
Rearrange Frames By Index . . . . . . . . . . 9042
Remove Frame . . . . . . . . . . . . . . . . . . . . . . 9043
MultiFrameStructure Properties . . . . . . . . . . . 9044
Frame Count . . . . . . . . . . . . . . . . . . . . . . . 9044
Frame Selector Rect . . . . . . . . . . . . . . . . . 9045
Frames[] . . . . . . . . . . . . . . . . . . . . . . . . . . . 9046
Visible Frame . . . . . . . . . . . . . . . . . . . . . . . 9046
Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9047
Sequence Methods . . . . . . . . . . . . . . . . . . 9047
Convert To Flat Sequence . . . . . . . 9048
Sequence Properties . . . . . . . . . . . . . . . . 9048
Sequence Locals[] . . . . . . . . . . . . . . 9049
ExternalNode . . . . . . . . . . . . . . . . . . . . . . . 9049
CaseStructure . . . . . . . . . . . . . . . . . . . . . . . . . . . 9049
CaseStructure Methods . . . . . . . . . . . . . . 9050
Get Frame Index . . . . . . . . . . . . . . . 9050
Remove Default . . . . . . . . . . . . . . . . 9051
Remove Empty Cases . . . . . . . . . . . 9052
Set Default Case . . . . . . . . . . . . . . . 9052
CaseStructure Properties . . . . . . . . . . . . 9053
Case Insensitive Match. . . . . . . . . . 9054
Default Case . . . . . . . . . . . . . . . . . . . 9054
Frame Names . . . . . . . . . . . . . . . . . . 9055
Selector . . . . . . . . . . . . . . . . . . . . . . . 9056
EventStructure . . . . . . . . . . . . . . . . . . . . . . . . . . 9056
EventStructure Methods . . . . . . . . . . . . . 9057
Get Event Data Node . . . . . . . . . . . 9057
Get Event Filter Node . . . . . . . . . . . 9058
Get Handled Events . . . . . . . . . . . . 9059

© National Instruments 229


LabVIEW Programming Reference Manual

Set Handled Events . . . . . . . . . . . . 9061


EventStructure Properties . . . . . . . . . . . 9062
Dynamic Terminal (Left) . . . . . . . . 9062
Dynamic Terminal (Right) . . . . . . . 9063
Dynamic Terminals Visible? . . . . . 9064
Event Selectors . . . . . . . . . . . . . . . . 9064
Number of Event Frames . . . . . . . . 9065
Timeout Terminal . . . . . . . . . . . . . . 9066
DisableStructure . . . . . . . . . . . . . . . . . . . . . . . . . 9066
DisableStructure Methods . . . . . . . . . . . 9067
Change Disable Style . . . . . . . . . . . 9067
Get Frame Index . . . . . . . . . . . . . . . 9068
Remove Empty Frames . . . . . . . . . 9069
DisableStructure Properties . . . . . . . . . . 9070
Active Frame. . . . . . . . . . . . . . . . . . . 9070
Conditions . . . . . . . . . . . . . . . . . . . . 9071
Default Frame . . . . . . . . . . . . . . . . . 9072
Disable Style. . . . . . . . . . . . . . . . . . . 9072
RaceStructureNode . . . . . . . . . . . . . . . . . . . . . . 9073
SimulationNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9073
SimulationNode Properties . . . . . . . . . . . . . . . 9073
SIMConfigNode . . . . . . . . . . . . . . . . . . . . . 9074
SIMOutputNode . . . . . . . . . . . . . . . . . . . . 9074
SynchronousDataFlowNode . . . . . . . . . . . . . . . . . . . 9075
SynchronousDataFlowNode Properties . . . . 9075
Sdf Config Node . . . . . . . . . . . . . . . . . . . . 9076
TimedSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9076
TimedSequence Methods . . . . . . . . . . . . . . . . . 9076
Convert To FlatSequence . . . . . . . . . . . . 9077
Convert To TimedLoop . . . . . . . . . . . . . . 9078
TimedSequence Properties . . . . . . . . . . . . . . . 9078
Embedded Flat Sequence . . . . . . . . . . . . 9079
StatechartStructureNode . . . . . . . . . . . . . . . . . . . . . . 9079
JoinNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9079
ForkNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9080
StateNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9080

230 ni.com
LabVIEW Programming Reference Manual

JunctionNode . . . . . . . . . . . . . . . . . . . . . . . . . . . 9080
RegionNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9080
InPlaceElementStructure . . . . . . . . . . . . . . . . . . . . . . 9080
InPlaceElementStructure Methods . . . . . . . . . 9080
Add In Place Pair . . . . . . . . . . . . . . . . . . . . 9081
InPlaceElementStructure Properties . . . . . . . 9082
DecomposerList[] . . . . . . . . . . . . . . . . . . . 9082
Recomposer List[] . . . . . . . . . . . . . . . . . . . 9083
TargetStructureNode . . . . . . . . . . . . . . . . . . . . . . . . . . 9084
ClosureStructureNode . . . . . . . . . . . . . . . . . . . . . . . . . 9084
Formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9084
Formula Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9084
Add Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9084
Add Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9085
Formula Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 9086
Formula Expression . . . . . . . . . . . . . . . . . . . . . . 9087
Formula Parameters[] . . . . . . . . . . . . . . . . . . . . 9087
Scrollbar Visible?. . . . . . . . . . . . . . . . . . . . . . . . . 9088
ScriptNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9089
MathScriptNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9089
MathScriptNode Methods . . . . . . . . . . . . . . . . . 9089
Set MathScript Node Line Breakpoint . . . . . .
9089
InlineCNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9090
GrowableFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9090
GrowableFunction Methods . . . . . . . . . . . . . . . . . . . . 9091
Resize:Add Chunk . . . . . . . . . . . . . . . . . . . . . . . . 9091
Resize:Remove Chunk . . . . . . . . . . . . . . . . . . . . 9092
GrowableFunction Properties . . . . . . . . . . . . . . . . . . 9093
Terminal Height. . . . . . . . . . . . . . . . . . . . . . . . . . 9093
BuildClusterArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9094
CompoundArithmetic . . . . . . . . . . . . . . . . . . . . . . . . . 9094
CompoundArithmetic Properties . . . . . . . . . . 9094
Invert Inputs?[] . . . . . . . . . . . . . . . . . . . . . 9095
Invert Output . . . . . . . . . . . . . . . . . . . . . . . 9095
Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9096

© National Instruments 231


LabVIEW Programming Reference Manual

IndexArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9097
IndexArray Properties . . . . . . . . . . . . . . . . . . . . 9097
Array Input Terminal . . . . . . . . . . . . . . . . 9097
Index Count . . . . . . . . . . . . . . . . . . . . . . . . 9098
Index Terminals[][] . . . . . . . . . . . . . . . . . . 9099
Output Terminals[] . . . . . . . . . . . . . . . . . . 9099
CIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9100
CIN Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9100
Add Parameter After . . . . . . . . . . . . . . . . . 9101
Create C File . . . . . . . . . . . . . . . . . . . . . . . . 9102
Load Code Resource . . . . . . . . . . . . . . . . . 9102
Purge Code Resource . . . . . . . . . . . . . . . . 9103
Remove Parameter . . . . . . . . . . . . . . . . . . 9104
CIN Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 9105
Code Resource Path . . . . . . . . . . . . . . . . . 9105
Input Terminals[] . . . . . . . . . . . . . . . . . . . 9106
Output Terminals[] . . . . . . . . . . . . . . . . . . 9106
ParameterCount . . . . . . . . . . . . . . . . . . . . 9107
CallLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9108
CallLibrary Methods . . . . . . . . . . . . . . . . . . . . . . 9108
Create C File . . . . . . . . . . . . . . . . . . . . . . . . 9108
Prototype . . . . . . . . . . . . . . . . . . . . . . . . . . 9109
CallLibrary Properties . . . . . . . . . . . . . . . . . . . . 9110
Abort Callback . . . . . . . . . . . . . . . . . . . . . . 9111
Any Thread? . . . . . . . . . . . . . . . . . . . . . . . . 9112
Calling Convention . . . . . . . . . . . . . . . . . . 9112
Dynamic Library? . . . . . . . . . . . . . . . . . . . 9113
Error Checking Level . . . . . . . . . . . . . . . . 9114
Function Name . . . . . . . . . . . . . . . . . . . . . 9115
Input Terminals[] . . . . . . . . . . . . . . . . . . . 9115
Library Path . . . . . . . . . . . . . . . . . . . . . . . . 9116
Output Terminals [] . . . . . . . . . . . . . . . . . 9117
Parameter Info . . . . . . . . . . . . . . . . . . . . . . 9117
Reserve Callback . . . . . . . . . . . . . . . . . . . . 9118
Unreserve Callback. . . . . . . . . . . . . . . . . . 9119
FormatScanString. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9119

232 ni.com
LabVIEW Programming Reference Manual

FormatScanString Properties . . . . . . . . . . . . . 9120


Format String . . . . . . . . . . . . . . . . . . . . . . . 9120
ObjectFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9120
ObjectFunction Properties . . . . . . . . . . . . . . . . 9121
Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9121
Name Format . . . . . . . . . . . . . . . . . . . . . . . 9122
Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9122
Property Methods . . . . . . . . . . . . . . . . . . . 9123
Add Property Item After . . . . . . . . . 9123
Disconnect From Control . . . . . . . 9124
Get Property Item . . . . . . . . . . . . . . 9125
Link To Control . . . . . . . . . . . . . . . . 9126
Remove Property Item . . . . . . . . . . 9127
Set Properties[] . . . . . . . . . . . . . . . . 9127
Property Properties . . . . . . . . . . . . . . . . . 9129
All Supported Properties . . . . . . . . 9129
Flags:Has Ignore Errors Inside Node . . .
9130
Ignore Errors Inside Node? . . . . . . 9131
Linked Control . . . . . . . . . . . . . . . . . 9132
Properties[] . . . . . . . . . . . . . . . . . . . 9132
Property Count . . . . . . . . . . . . . . . . 9133
Property Items[] . . . . . . . . . . . . . . . 9134
Property Node Class Name . . . . . . 9135
Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9135
Invoke Methods . . . . . . . . . . . . . . . . . . . . . 9136
Disconnect From Control . . . . . . . 9136
Link To Control . . . . . . . . . . . . . . . . 9137
Set Method . . . . . . . . . . . . . . . . . . . . 9138
Invoke Properties . . . . . . . . . . . . . . . . . . . 9139
All Supported Methods . . . . . . . . . 9139
Input Terminals [] . . . . . . . . . . . . . . 9140
Invoke Node Class Name . . . . . . . . 9141
Linked Control . . . . . . . . . . . . . . . . . 9142
Method . . . . . . . . . . . . . . . . . . . . . . . 9142
Output Terminals [] . . . . . . . . . . . . 9143

© National Instruments 233


LabVIEW Programming Reference Manual

Constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9144
Constructor Properties . . . . . . . . . . . . . . 9144
Constructor Node Class Name . . . 9144
Input Terminals [] . . . . . . . . . . . . . . 9145
Output Terminals [] . . . . . . . . . . . . 9146
Bundler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9146
Bundler Methods . . . . . . . . . . . . . . . . . . . . . . . . 9147
AddInputAfter . . . . . . . . . . . . . . . . . . . . . . 9147
RemoveInput . . . . . . . . . . . . . . . . . . . . . . . 9148
Bundler Properties . . . . . . . . . . . . . . . . . . . . . . . 9149
Input Count . . . . . . . . . . . . . . . . . . . . . . . . 9149
Input Terminals . . . . . . . . . . . . . . . . . . . . . 9150
BuildArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9150
BuildArray Properties . . . . . . . . . . . . . . . . 9150
Concatenate Inputs . . . . . . . . . . . . 9151
NamedBundler . . . . . . . . . . . . . . . . . . . . . . . . . . 9151
NamedBundler Properties . . . . . . . . . . . 9152
Available Elements[]. . . . . . . . . . . . 9152
Element Names[] . . . . . . . . . . . . . . 9153
Full Element Names[] . . . . . . . . . . . 9154
Full Names Visible? . . . . . . . . . . . . . 9154
Unbundler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9155
Unbundler Methods . . . . . . . . . . . . . . . . . . . . . . 9155
Add Output After . . . . . . . . . . . . . . . . . . . . 9156
Remove Output . . . . . . . . . . . . . . . . . . . . . 9157
Unbundler Properties . . . . . . . . . . . . . . . . . . . . 9157
Output Count . . . . . . . . . . . . . . . . . . . . . . . 9158
Output Terminals[] . . . . . . . . . . . . . . . . . . 9158
NamedUnbundler . . . . . . . . . . . . . . . . . . . . . . . . 9159
NamedUnbundler Properties . . . . . . . . . 9159
Available Elements[]. . . . . . . . . . . . 9160
Element Names[] . . . . . . . . . . . . . . 9160
Full Element Names[] . . . . . . . . . . . 9161
Full Names Visible? . . . . . . . . . . . . . 9162
RegisterForEvents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9163
RegisterForEvents Properties. . . . . . . . . . . . . . 9163

234 ni.com
LabVIEW Programming Reference Manual

Event Locks Panel . . . . . . . . . . . . . . . . . . . 9163


Event Types . . . . . . . . . . . . . . . . . . . . . . . . 9164
BuildSetNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9165
BuildMapNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9165
AssertStructuralTypeMismatchNode . . . . . . . . . . . . 9165
ControlReferenceConstant . . . . . . . . . . . . . . . . . . . . . . . . . . 9165
ControlReferenceConstant Properties . . . . . . . . . . . 9165
Control Reference Linked To . . . . . . . . . . . . . . 9165
StaticVIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9166
StaticVIReference Properties . . . . . . . . . . . . . . . . . . . 9166
Is Strict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9166
VI Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9167
VI Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9168
XNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9168
XDataNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9168
XDataNode Properties . . . . . . . . . . . . . . . . . . . . 9168
Is XNode Hidden . . . . . . . . . . . . . . . . . . . . 9169
SharedVariableNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9169
SharedVariableNode Methods . . . . . . . . . . . . . . . . . . 9169
Change to Constant . . . . . . . . . . . . . . . . . . . . . . 9170
Change to Control. . . . . . . . . . . . . . . . . . . . . . . . 9171
Change to Indicator . . . . . . . . . . . . . . . . . . . . . . 9171
SharedVariableNode Properties . . . . . . . . . . . . . . . . 9172
Allow Absolute? . . . . . . . . . . . . . . . . . . . . . . . . . . 9173
Allow Direct? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9174
Allow Read? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9174
Allow Relative? . . . . . . . . . . . . . . . . . . . . . . . . . . 9175
Allow Scanned? . . . . . . . . . . . . . . . . . . . . . . . . . . 9176
Allow Write? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9176
IOVLocalAccessMode . . . . . . . . . . . . . . . . . . . . . 9177
Relative Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . 9178
Shared Variable Project Item . . . . . . . . . . . . . . 9178
Show Timeout? . . . . . . . . . . . . . . . . . . . . . . . . . . 9179
Show Timestamp? . . . . . . . . . . . . . . . . . . . . . . . 9180
Timeout Allowed? . . . . . . . . . . . . . . . . . . . . . . . . 9181
Timestamp Allowed? . . . . . . . . . . . . . . . . . . . . . 9181

© National Instruments 235


LabVIEW Programming Reference Manual

Write?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9182
InPlaceBorderNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9183
InPlaceBorderNode Properties . . . . . . . . . . . . . . . . . 9183
Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9183
InPlaceElementNode . . . . . . . . . . . . . . . . . . . . . . . . . . 9184
InPlaceVariantNode . . . . . . . . . . . . . . . . . . . . . . . . . . . 9184
InPlaceArrayNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9184
InPlaceArrayNode Methods . . . . . . . . . . . . . . . 9184
Resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9184
InPlaceArrayNode Properties . . . . . . . . . . . . . . 9185
Array Input Terminal . . . . . . . . . . . . . . . . 9186
Index Count . . . . . . . . . . . . . . . . . . . . . . . . 9187
Index Terminalsl[][] . . . . . . . . . . . . . . . . . 9187
Output Terminals[] . . . . . . . . . . . . . . . . . . 9188
Terminal Height . . . . . . . . . . . . . . . . . . . . . 9189
InPlaceClusterNode . . . . . . . . . . . . . . . . . . . . . . . . . . . 9189
InPlaceClusterNode Methods. . . . . . . . . . . . . . 9190
Add Output After . . . . . . . . . . . . . . . . . . . . 9190
Remove Output . . . . . . . . . . . . . . . . . . . . . 9191
Resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9192
InPlaceClusterNode Properties . . . . . . . . . . . . 9193
Available Elements[]. . . . . . . . . . . . . . . . . 9193
Element Names[] . . . . . . . . . . . . . . . . . . . 9194
Full Element Names[]. . . . . . . . . . . . . . . . 9195
Full Names Visible? . . . . . . . . . . . . . . . . . . 9195
Output Count . . . . . . . . . . . . . . . . . . . . . . . 9196
Output Terminals[] . . . . . . . . . . . . . . . . . . 9197
Terminal Height . . . . . . . . . . . . . . . . . . . . . 9198
InPlaceDataValRefNode . . . . . . . . . . . . . . . . . . . . . . . 9198
InPlaceDataValRefNode Properties . . . . . . . . 9198
Allow Parallel Read Only Access . . . . . . 9199
InPlaceArraySplitNode . . . . . . . . . . . . . . . . . . . . . . . . 9199
InPlaceArraySplitNode Properties . . . . . . . . . 9200
Array Terminal . . . . . . . . . . . . . . . . . . . . . . 9200
Length Terminals . . . . . . . . . . . . . . . . . . . 9201
Split Count . . . . . . . . . . . . . . . . . . . . . . . . . 9202

236 ni.com
LabVIEW Programming Reference Manual

Split Dimension . . . . . . . . . . . . . . . . . . . . . 9202


Split Terminals. . . . . . . . . . . . . . . . . . . . . . 9203
Terminal Height . . . . . . . . . . . . . . . . . . . . . 9204
InPlaceVariantAttributeNode . . . . . . . . . . . . . . . . . . . 9204
InPlaceVariantAttributeNode Methods . . . . . 9205
Resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9205
InPlaceVariantAttributeNode Properties . . . . 9206
Attribute Count . . . . . . . . . . . . . . . . . . . . . 9206
Attribute Terminal Height . . . . . . . . . . . . 9207
Attribute Terminals . . . . . . . . . . . . . . . . . . 9208
Found Terminals . . . . . . . . . . . . . . . . . . . . 9209
Header Height . . . . . . . . . . . . . . . . . . . . . . 9209
Name Terminals . . . . . . . . . . . . . . . . . . . . 9210
Variant Input . . . . . . . . . . . . . . . . . . . . . . . 9211
InPlaceMapNode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9211
InPlaceMapNode Methods . . . . . . . . . . . . . . . . 9211
Set number of Key/Value Pairs . . . . . . . . 9212
InPlaceMapNode Properties . . . . . . . . . . . . . . 9212
Action Terminals . . . . . . . . . . . . . . . . . . . . 9213
DefaultValueTerminals . . . . . . . . . . . . . . 9214
Found Terminals . . . . . . . . . . . . . . . . . . . . 9214
Key Height . . . . . . . . . . . . . . . . . . . . . . . . . 9215
Key Terminals . . . . . . . . . . . . . . . . . . . . . . 9216
KeyCount . . . . . . . . . . . . . . . . . . . . . . . . . . 9216
Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9217
Map Height . . . . . . . . . . . . . . . . . . . . . . . . . 9218
Value Terminals . . . . . . . . . . . . . . . . . . . . . 9218
FeedbackNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9219
FeedbackNode Methods . . . . . . . . . . . . . . . . . . . . . . . 9219
Highlight Initializer . . . . . . . . . . . . . . . . . . . . . . . 9220
Replace With Shift Register . . . . . . . . . . . . . . . . 9220
FeedbackNode Properties . . . . . . . . . . . . . . . . . . . . . 9221
Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9222
Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9223
Enable Terminal Shown . . . . . . . . . . . . . . . . . . 9224
Header Appearance . . . . . . . . . . . . . . . . . . . . . . 9224

© National Instruments 237


LabVIEW Programming Reference Manual

Ignore FPGA Reset Method . . . . . . . . . . . . . . . . 9225


Initialization Mux Location . . . . . . . . . . . . . . . . 9226
Initialization Type . . . . . . . . . . . . . . . . . . . . . . . . 9227
Initializer Is On Loop . . . . . . . . . . . . . . . . . . . . . 9227
Initializer Terminal . . . . . . . . . . . . . . . . . . . . . . . 9228
Initializer's Loop . . . . . . . . . . . . . . . . . . . . . . . . . 9229
Input Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . 9230
Output Terminal . . . . . . . . . . . . . . . . . . . . . . . . . 9230
MathScriptCallByRef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9231
SharedVariableDynamicOpen . . . . . . . . . . . . . . . . . . . . . . . 9231
SharedVariableDynamicRead . . . . . . . . . . . . . . . . . . . . . . . 9231
SharedVariableDynamicWrite . . . . . . . . . . . . . . . . . . . . . . . 9231
TextBaseNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9231
TextBaseNode Properties . . . . . . . . . . . . . . . . . . . . . . 9231
Contained Text . . . . . . . . . . . . . . . . . . . . . . . . . . 9232
ExpressionNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9232
Wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9232
Wire Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9232
Attach Probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9233
Clean Up Wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9234
Copy Probes To Companion . . . . . . . . . . . . . . . . . . . . 9235
Delete Joint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9235
Disconnect Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . 9236
Insert Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9237
Remove Loose Ends . . . . . . . . . . . . . . . . . . . . . . . . . . . 9238
Remove Probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9238
Wire Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9239
Breakpoint Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9240
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9240
Is Broken? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9241
Joints[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9242
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9243
Probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9244
Terminals[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9245
Wire Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9245
PropertyItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9246

238 ni.com
LabVIEW Programming Reference Manual

PropertyItem Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9246


Set Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9246
PropertyItem Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9247
Is Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9248
Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9248
Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9249
FlatSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9250
FlatSequence Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9250
Add Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9250
Auto Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9251
Convert To Timed Sequence . . . . . . . . . . . . . . . . . . . 9252
Remove Flat Sequence . . . . . . . . . . . . . . . . . . . . . . . . 9253
Remove Frame. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9253
FlatSequence Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . 9254
AutoSize To Fit Contents? . . . . . . . . . . . . . . . . . . . . . . 9254
Breakpoint Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9255
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9256
Frames[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9256
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9257
Subdiagram Label Visible . . . . . . . . . . . . . . . . . . . . . . 9258
Terminals[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9258
TimeFlatSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9259
SimulationDCO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9259
FlatSequenceInnerTunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9259
FlatSequenceInnerTunnel Properties . . . . . . . . . . . . . . . . 9259
Left Frame. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9260
Left Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9260
Right Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9261
Right Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9261
FlatSequenceOuterTunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9262
FlatSequenceOuterTunnel Properties . . . . . . . . . . . . . . . . 9262
Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9262
Inner Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9263
Outer Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9264
PolymorphicVISelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9264
PolymorphicVISelector Properties . . . . . . . . . . . . . . . . . . . 9264

© National Instruments 239


LabVIEW Programming Reference Manual

Instance Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9265


SynchronousDataFlowDCO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9265
TimedStructDCO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9265
Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9265
Plot Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9265
Anti-aliased . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9267
Bar Plot Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9267
Digital Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9268
Digital Transition Location . . . . . . . . . . . . . . . . . . . . . . . . . . 9269
Digital Transition Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9269
Fill To . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9270
Fill/Point Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9271
Label Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9271
Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9272
Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9273
Plot Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9273
Plot Interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9274
Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9275
Point Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9276
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9276
X Scale Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9277
Y Scale Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9278
Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9278
Cursor Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9278
Allow Drag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9280
Cursor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9281
Cursor Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9281
Cursor Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9282
Cursor Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9283
Cursor Name Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9283
Cursor Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9284
Cursor Point Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9285
Cursor Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9286
Cursor Position:Cursor X . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9286
Cursor Position:Cursor Y . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9287
Cursor Selection Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9288

240 ni.com
LabVIEW Programming Reference Manual

Cursor Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9288


Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9289
Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9290
Plot Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9291
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9291
Watch All Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9292
Watch Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9293
X Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9293
Y Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9294
Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9294
Page Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9295
Import Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9295
Rearrange Tabbing Order . . . . . . . . . . . . . . . . . . . . . . . . . . . 9296
Remove Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9296
Page Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9297
Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9298
Colors:BG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9299
Colors:FG Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9299
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9300
Independent Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9301
Page Enabled State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9302
Page Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9302
Page Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9303
Tab Caption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9304
Tabbing Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9304
Tip Strip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9305
Z-Order:All Objects[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9306
Z-Order:Decorations[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9306
ConnectorPane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9307
ConnectorPane Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9307
Assign Control To Terminal . . . . . . . . . . . . . . . . . . . . . . . . . 9308
Disconnect All Terminals. . . . . . . . . . . . . . . . . . . . . . . . . . . . 9309
Disconnect Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9309
Flip Horizontal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9310
Flip Vertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9311
Rotate By 90 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9311

© National Instruments 241


LabVIEW Programming Reference Manual

Wiring Rule:Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9312


Wiring Rule:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9313
ConnectorPane Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9314
Controls[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9314
Icon Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9315
Number of Connection Terminals . . . . . . . . . . . . . . . . . . . . 9315
Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9316
Terminal Bounds[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9317
WiringRules[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9318
Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9318
Bus Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9318
Bar Plot Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9320
Digital Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9320
Digital Transition Location . . . . . . . . . . . . . . . . . . . . . . . . . . 9321
Digital Transition Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9322
Fill To . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9322
Fill/Point Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9323
Fixed Point Digits of Precision . . . . . . . . . . . . . . . . . . . . . . . 9324
Fixed Point Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9325
Fixed Point Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9326
Label Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9327
Line Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9327
Line Width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9328
Plot Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9329
Plot Interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9329
Plot Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9330
Point Style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9331
Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9332
X Scale Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9332
Y Scale Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9333
Probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9333
Probe Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9333
Wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9334
SubWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9334
SubWizard Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9334
Is Locked By Me . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9335

242 ni.com
LabVIEW Programming Reference Manual

Lock Const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9336


Lock Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9337
Unlock Const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9337
Unlock Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9338
SubWizard Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9339
Locked Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9339
StateDiagramWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9340
StateDiagramWizard Methods . . . . . . . . . . . . . . . . . . . . . . . 9340
Remove State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9340
CodeWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9341
CodeWizard Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9341
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9341
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9342
ExternalEditorWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9342
ExternalEditorWizard Methods . . . . . . . . . . . . . . . . . . . . . . 9343
LaunchEditor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9343
ExternalEditorWizard Properties . . . . . . . . . . . . . . . . . . . . . 9343
MasterContainer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9344
MasterObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9344
FlatSequenceFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9345
FlatSequenceFrame Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 9345
Content Rect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9345
Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9346
Frame Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9347
Left Side Inner Tunnels[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9347
Outer Tunnels[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9348
Right Side Inner Tunnels[] . . . . . . . . . . . . . . . . . . . . . . . . . . 9348
TimeSequenceFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9349
MasterWizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9349
Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9349
Project Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9349
Browse Variable Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9351
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9351
Close Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9352
Deploy Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9353
Item From Item ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9354

© National Instruments 243


LabVIEW Programming Reference Manual

Local Project Settings:Delete Item . . . . . . . . . . . . . . . . . . . . . . . . 9355


Local Project Settings:Delete Section . . . . . . . . . . . . . . . . . . . . . 9356
Local Project Settings:Get Item . . . . . . . . . . . . . . . . . . . . . . . . . . . 9357
Local Project Settings:Has Item . . . . . . . . . . . . . . . . . . . . . . . . . . 9358
Local Project Settings:Has Section . . . . . . . . . . . . . . . . . . . . . . . . 9359
Local Project Settings:Set Item . . . . . . . . . . . . . . . . . . . . . . . . . . . 9360
Open Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9361
Refresh Auto-Populating Folders . . . . . . . . . . . . . . . . . . . . . . . . . 9362
Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9363
Save As . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9364
Save Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9365
Save For Previous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9366
Undeploy Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9367
Project Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9367
Active Items In Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9368
Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9369
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9370
Items View Active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9371
My Computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9371
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9372
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9373
Root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9374
Selected Items in Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9375
Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9375
Window State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9376
ProjectItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9377
ProjectItem Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9377
Add File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9379
Add Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9380
Add Item From Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9382
Collapse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9383
Convert to Auto-populating Folder . . . . . . . . . . . . . . . . . . . . . . . 9383
Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9384
Expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9385
Get All Descendents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9385
Replace Item With . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9387

244 ni.com
LabVIEW Programming Reference Manual

Stop Auto-populating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9388


Tag:Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9389
Tag:Get Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9390
Tag:Get Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9390
Tag:Get XML Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9392
Tag:Set Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9393
Tag:Set XML Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9394
ProjectItem Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9395
Can Be Replaced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9397
Contains Conflicts?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9398
Display Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9399
Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9399
Find:Callers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9400
Find:Children . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9401
Find:Conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9401
Find:Friends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9402
Find:Items Incorrectly Claimed by a Library. . . . . . . . . . . . . . . . 9403
Find:Items that make this a dependency . . . . . . . . . . . . . . . . . . 9403
Find:Items with No Callers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9404
Find:Missing Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9405
Find:SubVIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9405
Find:Variable Callers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9406
Get Auto-populating Folder Path . . . . . . . . . . . . . . . . . . . . . . . . . 9407
HyperLink Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9407
Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9408
In Conflict? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9410
Is In Packed Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9411
Item ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9411
Library Item Type:String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9412
Library Item:Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9413
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9414
Owned Items[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9414
Owner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9415
Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9416
Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9417
Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9417

© National Instruments 245


LabVIEW Programming Reference Manual

Type GUID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9418


Type String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9419
VI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9420
VI Reference No Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9421
Variable Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9421
Visible In Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9422
Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9423
Library Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9423
Apply Icon To Existing VI Items . . . . . . . . . . . . . . . . . . . . . . 9425
Disconnect From Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9425
Disconnect Variables From Typedefs . . . . . . . . . . . . . . . . . 9426
Friends:Add Friend Library . . . . . . . . . . . . . . . . . . . . . . . . . . 9427
Friends:Add Friend VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9427
Friends:Remove Friended VI or Library . . . . . . . . . . . . . . . 9428
Hilite In Project Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9429
Icon:Get. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9430
Icon:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9431
Library Tag:Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9432
Library Tag:Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9433
Library Tag:Get Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9434
Library Tag:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9435
Lock State:Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9436
Lock State:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9437
Save:Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9439
Save:For Previous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9440
Save:Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9441
Source Scope:Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9442
Source Scope:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9443
Source Scope:Set and Propagate . . . . . . . . . . . . . . . . . . . . 9445
Library Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9446
AlarmsEvents:Database Computer . . . . . . . . . . . . . . . . . . . 9448
AlarmsEvents:Database Name . . . . . . . . . . . . . . . . . . . . . . 9448
AlarmsEvents:Database Path . . . . . . . . . . . . . . . . . . . . . . . . 9449
AlarmsEvents:Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9450
AlarmsEvents:Use DataLogging Database . . . . . . . . . . . . 9451
Contains Compiled Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 9451

246 ni.com
LabVIEW Programming Reference Manual

DataLogging:Database Computer . . . . . . . . . . . . . . . . . . . . 9452


DataLogging:Database Name . . . . . . . . . . . . . . . . . . . . . . . 9453
DataLogging:Database Path . . . . . . . . . . . . . . . . . . . . . . . . . 9454
DataLogging:Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9454
DataLogging:Lifespan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9455
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9456
Friends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9457
Help:Document Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9458
Help:Document Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9458
Is In Packed Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9459
Localized Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9460
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9461
Owning Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9462
Process:Save State Period . . . . . . . . . . . . . . . . . . . . . . . . . . 9462
Qualified Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9463
Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9463
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9464
XInterfaceLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9465
XInterfaceLibrary Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 9465
Add Ability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9465
Add Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9466
New Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9467
XControlLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9468
XNodeLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9468
LVClassLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9468
LVClassLibrary Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9469
Add Parent Interface . . . . . . . . . . . . . . . . . . . . . . . . . . 9470
Descendants Must Call Parent Item?:Get. . . . . . . . . 9470
Descendants Must Call Parent Item?:Set . . . . . . . . . 9471
Descendants Must Override Item?:Get . . . . . . . . . . . 9472
Descendants Must Override Item?:Set . . . . . . . . . . . 9473
Has Implementation? . . . . . . . . . . . . . . . . . . . . . . . . . 9474
Remove Parent Interface . . . . . . . . . . . . . . . . . . . . . . . 9476
Write Parent Interfaces . . . . . . . . . . . . . . . . . . . . . . . . 9477
Write Parent Library Paths . . . . . . . . . . . . . . . . . . . . . 9477
LVClassLibrary Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 9478

© National Instruments 247


LabVIEW Programming Reference Manual

Ancestor Restricts Reference Creation . . . . . . . . . . . 9480


Child References Restricted . . . . . . . . . . . . . . . . . . . . 9481
Children In Memory[] . . . . . . . . . . . . . . . . . . . . . . . . . . 9481
DefaultProbe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9482
Dynamic Member VIs[] . . . . . . . . . . . . . . . . . . . . . . . . . 9483
Is Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9483
Parent Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9484
Parent Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9485
Parent Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9485
Private Data Control . . . . . . . . . . . . . . . . . . . . . . . . . . . 9486
Self References Restricted . . . . . . . . . . . . . . . . . . . . . 9486
Simple Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9487
Static Member VIs[] . . . . . . . . . . . . . . . . . . . . . . . . . . . 9488
Transfer Must Overrides? . . . . . . . . . . . . . . . . . . . . . . 9488
Wire Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9489
StatechartLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9490
StatechartLibrary Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 9490
Generate Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9490
Generate Documentation . . . . . . . . . . . . . . . . . . . . . . 9491
StatechartLibrary Properties . . . . . . . . . . . . . . . . . . . . . . . . 9493
Code Generation Needed . . . . . . . . . . . . . . . . . . . . . . 9493
Has Diagram Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . 9494
TargetItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9494
TargetItem Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9494
Refresh Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9495
TargetItem Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9495
Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9496
Build Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9496
Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9497
PropertyFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9498
PropertyFolder Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9498
Add Property VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9498
XPropertyFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9499
XPropertyFolder Properties . . . . . . . . . . . . . . . . . . . . . . . . . 9499
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9499
Help Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9500

248 ni.com
LabVIEW Programming Reference Manual

Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9501
Long Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9502
LibraryData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9502
LVClassPropDefFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9502
LVClassPropDefFolder Properties . . . . . . . . . . . . . . . . . . . . . . . . . 9502
LongName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9503
ShortName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9504
SortKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9505
UniqueDataName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9505
BuildSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9506
Scene. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9506
SceneTexture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9506
SceneTexture Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9506
Transformation:Clear Transformation . . . . . . . . . . . . . . . . 9507
Transformation:Get Rotation . . . . . . . . . . . . . . . . . . . . . . . . 9508
Transformation:Get Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . 9509
Transformation:Get Translation . . . . . . . . . . . . . . . . . . . . . 9509
Transformation:Rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9510
Transformation:Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9511
Transformation:Set Rotation . . . . . . . . . . . . . . . . . . . . . . . . 9512
Transformation:Set Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . 9513
Transformation:Set Translation . . . . . . . . . . . . . . . . . . . . . 9513
Transformation:Translate . . . . . . . . . . . . . . . . . . . . . . . . . . . 9514
SceneTexture Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9515
Apply Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9516
Blend Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9516
Filter Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9517
Horizontal Wrap Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9518
Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9519
Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9521
Vertical Wrap Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9521
SceneNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9522
SceneNode Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9522
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9522
SceneLight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9523
SceneLight Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9523

© National Instruments 249


LabVIEW Programming Reference Manual

Ambient Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9524


At Infinity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9525
Attenuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9526
Attenuation:Constant Attenuation . . . . . . . . . . . . . . 9527
Attenuation:Linear Attenuation . . . . . . . . . . . . . . . . . 9528
Attenuation:Quadratic Attenuation . . . . . . . . . . . . . 9529
Cutoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9529
Diffuse Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9530
Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9531
Exponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9532
Light Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9532
Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9533
Specular Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9534
SceneObject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9535
SceneObject Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9535
Clip Plane:Add Clip Plane . . . . . . . . . . . . . . . . . . . . . . 9537
Clip Plane:Clip Plane Count . . . . . . . . . . . . . . . . . . . . 9537
Clip Plane:Get Clip Plane . . . . . . . . . . . . . . . . . . . . . . 9538
Clip Plane:Get State . . . . . . . . . . . . . . . . . . . . . . . . . . . 9539
Clip Plane:Remove Clip Plane . . . . . . . . . . . . . . . . . . 9540
Clip Plane:Set State . . . . . . . . . . . . . . . . . . . . . . . . . . . 9540
Light:Add Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9542
Light:Get Light . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9542
Light:Get State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9543
Light:Light Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9544
Light:Remove Light . . . . . . . . . . . . . . . . . . . . . . . . . . . 9545
Light:Set State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9545
Object:Add Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9546
Object:Find Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9547
Object:Get Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9548
Object:Object Count . . . . . . . . . . . . . . . . . . . . . . . . . . 9549
Object:Remove Object. . . . . . . . . . . . . . . . . . . . . . . . . 9549
Set Billboard Params . . . . . . . . . . . . . . . . . . . . . . . . . . 9550
Set Drawable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9552
Texture:Remove Texture . . . . . . . . . . . . . . . . . . . . . . . 9552
Texture:Set Texture. . . . . . . . . . . . . . . . . . . . . . . . . . . . 9553

250 ni.com
LabVIEW Programming Reference Manual

Transformation:Clear . . . . . . . . . . . . . . . . . . . . . . . . . . 9554
Transformation:Get Rotation . . . . . . . . . . . . . . . . . . . 9554
Transformation:Get Scale . . . . . . . . . . . . . . . . . . . . . . 9555
Transformation:Get Translation . . . . . . . . . . . . . . . . 9556
Transformation:Rotate . . . . . . . . . . . . . . . . . . . . . . . . 9556
Transformation:Scale . . . . . . . . . . . . . . . . . . . . . . . . . 9557
Transformation:Set Rotation . . . . . . . . . . . . . . . . . . . 9558
Transformation:Set Scale . . . . . . . . . . . . . . . . . . . . . . 9559
Transformation:Set Translation . . . . . . . . . . . . . . . . 9560
Transformation:Translate . . . . . . . . . . . . . . . . . . . . . . 9561
SceneObject Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9562
Billboard:Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9565
Billboard:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9565
Billboard:Normal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9566
Billboard:Positions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9566
Blending:Bin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9567
Blending:Function:Destination . . . . . . . . . . . . . . . . . 9568
Blending:Function:Source . . . . . . . . . . . . . . . . . . . . . 9569
Blending:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9569
Draw Style:Face Culling Mode . . . . . . . . . . . . . . . . . . 9570
Draw Style:Frontface Mode. . . . . . . . . . . . . . . . . . . . . 9571
Draw Style:Line Width . . . . . . . . . . . . . . . . . . . . . . . . . 9571
Draw Style:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9572
Draw Style:Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . 9572
Drawable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9573
Fog:Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9574
Fog:Density . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9575
Fog:End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9575
Fog:Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9576
Fog:Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9577
Line Stipple:Factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9577
Line Stipple:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9578
Line Stipple:Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . 9578
Material:Ambient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9579
Material:Color Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . 9580
Material:Diffuse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9581

© National Instruments 251


LabVIEW Programming Reference Manual

Material:Emission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9581
Material:Shininess . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9582
Material:Specular . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9583
PolygonOffset:Factor . . . . . . . . . . . . . . . . . . . . . . . . . . 9584
PolygonOffset:Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . 9585
PolygonOffset:Units . . . . . . . . . . . . . . . . . . . . . . . . . . . 9585
Specials:Anti-aliasing . . . . . . . . . . . . . . . . . . . . . . . . . 9586
Specials:Autonormalizing . . . . . . . . . . . . . . . . . . . . . . 9586
Specials:Depth Test . . . . . . . . . . . . . . . . . . . . . . . . . . . 9587
Specials:Lighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9588
Specials:Shade Model . . . . . . . . . . . . . . . . . . . . . . . . . 9588
Specials:Texturing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9589
Texture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9590
Transformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9590
View Port:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9591
View Port:View Port . . . . . . . . . . . . . . . . . . . . . . . . . . . 9591
SceneClipPlane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9592
SceneClipPlane Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 9592
Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9593
Plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9593
SceneDrawable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9594
SceneGeometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9594
SceneGeometry Properties . . . . . . . . . . . . . . . . . . . . . . . . . 9594
Texture Generator Mode . . . . . . . . . . . . . . . . . . . . . . . 9595
Texture Generator S Plane . . . . . . . . . . . . . . . . . . . . . 9596
Texture Generator T Plane . . . . . . . . . . . . . . . . . . . . . 9596
SceneMesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9597
SceneMesh Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 9597
Delaunay Mesh . . . . . . . . . . . . . . . . . . . . . . . . . . 9598
Set Mesh Parameters . . . . . . . . . . . . . . . . . . . . . 9599
Share Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9602
SceneMesh Properties . . . . . . . . . . . . . . . . . . . . . . . . . 9603
Color Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9604
Color Binding Mode . . . . . . . . . . . . . . . . . . . . . . 9605
Draw Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9606
Indices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9606

252 ni.com
LabVIEW Programming Reference Manual

Normal Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9607


Normal Binding Mode . . . . . . . . . . . . . . . . . . . . 9608
Texture Coordinates [] . . . . . . . . . . . . . . . . . . . . 9609
Use Display List? . . . . . . . . . . . . . . . . . . . . . . . . . 9610
Vertex Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9610
SceneHeightField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9611
SceneHeightField Properties . . . . . . . . . . . . . . . . . . . 9611
Base Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9612
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9613
Column Interval . . . . . . . . . . . . . . . . . . . . . . . . . 9614
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9614
Row Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9615
SceneCylinder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9616
SceneCylinder Properties . . . . . . . . . . . . . . . . . . . . . . 9616
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9616
Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9617
Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9618
Radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9619
SceneSphere . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9619
SceneSphere Properties . . . . . . . . . . . . . . . . . . . . . . . 9619
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9620
Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9621
Radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9622
SceneCone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9622
SceneCone Properties . . . . . . . . . . . . . . . . . . . . . . . . . 9622
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9623
Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9624
Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9625
Radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9625
SceneBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9626
SceneBox Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 9626
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9626
Length X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9627
Length Y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9628
Length Z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9629
SceneText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9629

© National Instruments 253


LabVIEW Programming Reference Manual

SceneText Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9629


Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9631
Alignment:Horizontal . . . . . . . . . . . . . . . . . . . . . . . . . 9631
Alignment:Vertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9632
Axis Alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9633
Character Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9633
Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9634
Font Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9635
Text. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9635
Vertical? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9636
Wrap Distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9637
SceneWindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9638
SceneWindow Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9638
AutoFocus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9638
Pick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9639
Projection:Frustum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9640
Projection:Orthographic . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9641
Projection:Perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9643
Redraw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9644
Render to Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9644
Setup Camera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9645
WindowToObjectCoords . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9646
SceneWindow Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9647
Automatic Projection Mode . . . . . . . . . . . . . . . . . . . . . . . . . 9648
Background Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9648
Camera Controller:Auto Redraw . . . . . . . . . . . . . . . . . . . . . 9649
Camera Controller:Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9650
ModelView Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9650
Projection Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9651
Scene . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9652
Window Bounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9652
Window State. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9653
Window Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9654
Variable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9654
Variable Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9654
Disconnect From Typedefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9655

254 ni.com
LabVIEW Programming Reference Manual

Variable Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9655


Alarming:BadStatus:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9667
Alarming:BadStatus:Allow Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 9668
Alarming:BadStatus:Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9669
Alarming:BadStatus:Description. . . . . . . . . . . . . . . . . . . . . . . . . . 9669
Alarming:BadStatus:Enabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9670
Alarming:BadStatus:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9671
Alarming:BadStatus:Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9672
Alarming:Boolean:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9673
Alarming:Boolean:Alarm On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9673
Alarming:Boolean:Allow Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9674
Alarming:Boolean:Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9675
Alarming:Boolean:Description . . . . . . . . . . . . . . . . . . . . . . . . . . . 9676
Alarming:Boolean:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9677
Alarming:Boolean:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9678
Alarming:Boolean:Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9678
Alarming:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9679
Alarming:Event On Data Change . . . . . . . . . . . . . . . . . . . . . . . . . . 9680
Alarming:Event On User Input Only . . . . . . . . . . . . . . . . . . . . . . . 9681
Alarming:Hi:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9681
Alarming:Hi:Allow Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9682
Alarming:Hi:Area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9683
Alarming:Hi:Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9684
Alarming:Hi:Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9685
Alarming:Hi:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9685
Alarming:Hi:Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9686
Alarming:Hi:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9687
Alarming:Hi:Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9688
Alarming:HiHi:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9689
Alarming:HiHi:Allow Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9690
Alarming:HiHi:Area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9690
Alarming:HiHi:Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9691
Alarming:HiHi:Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9692
Alarming:HiHi:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9693
Alarming:HiHi:Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9694
Alarming:HiHi:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9695

© National Instruments 255


LabVIEW Programming Reference Manual

Alarming:HiHi:Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9696
Alarming:Lo:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9696
Alarming:Lo:Allow Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9697
Alarming:Lo:Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9698
Alarming:Lo:Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9699
Alarming:Lo:Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9700
Alarming:Lo:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9701
Alarming:Lo:Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9701
Alarming:Lo:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9702
Alarming:Lo:Priority. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9703
Alarming:LoLo:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9704
Alarming:LoLo:Allow Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9705
Alarming:LoLo:Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9705
Alarming:LoLo:Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9706
Alarming:LoLo:Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9707
Alarming:LoLo:Enabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9708
Alarming:LoLo:Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9709
Alarming:LoLo:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9710
Alarming:LoLo:Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9711
Alarming:RateOfChange:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . 9711
Alarming:RateOfChange:Allow Log . . . . . . . . . . . . . . . . . . . . . . . 9712
Alarming:RateOfChange:Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9713
Alarming:RateOfChange:Change . . . . . . . . . . . . . . . . . . . . . . . . . 9714
Alarming:RateOfChange:Description . . . . . . . . . . . . . . . . . . . . . . 9715
Alarming:RateOfChange:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . 9716
Alarming:RateOfChange:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 9716
Alarming:RateOfChange:Priority . . . . . . . . . . . . . . . . . . . . . . . . . 9717
Alarming:RateOfChange:Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9718
Alarming:U32BitField:Ack Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 9719
Alarming:U32BitField:Alarm On . . . . . . . . . . . . . . . . . . . . . . . . . . 9720
Alarming:U32BitField:Allow Log . . . . . . . . . . . . . . . . . . . . . . . . . . 9721
Alarming:U32BitField:Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9721
Alarming:U32BitField:Description . . . . . . . . . . . . . . . . . . . . . . . . 9722
Alarming:U32BitField:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . 9723
Alarming:U32BitField:InvertMask . . . . . . . . . . . . . . . . . . . . . . . . . 9724
Alarming:U32BitField:Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9725

256 ni.com
LabVIEW Programming Reference Manual

Alarming:U32BitField:Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9726
Alarming:U32BitField:Select Mask . . . . . . . . . . . . . . . . . . . . . . . . 9726
Data Type (Variant). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9727
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9728
I/O:Alias Access Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9729
I/O:Alias Project Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9729
I/O:Channel Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9730
I/O:Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9731
I/O:Enable Timestamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9731
I/O:Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9732
I/O:Network Published . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9733
Initial Value:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9733
Initial Value:Initial Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9734
Logging:Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9735
Logging:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9736
Logging:Log Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9736
Logging:Log Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9737
Logging:String Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9738
Logging:Time Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9739
Logging:Value Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9739
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9740
Network:Access Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9741
Network:Buffer Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9742
Network:Element Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9743
Network:Points Per Waveform . . . . . . . . . . . . . . . . . . . . . . . . . . . 9744
Network:Project Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9745
Network:Project Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9746
Network:URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9746
Network:Use Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9747
Network:Use Buffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9748
Real-Time:Array Length. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9749
Real-Time:Buffer Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9750
Real-Time:Datapoints In Waveform . . . . . . . . . . . . . . . . . . . . . . . 9750
Real-Time:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9751
Real-Time:Use Buffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9752
Scaling:Coerce. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9752

© National Instruments 257


LabVIEW Programming Reference Manual

Scaling:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9753
Scaling:EngUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9754
Scaling:Engineering Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9755
Scaling:Engineering Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9756
Scaling:Invert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9756
Scaling:Invert Mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9757
Scaling:Raw Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9758
Scaling:Raw Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9759
Scaling:Select Mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9760
Scaling:Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9761
Single-Process:Enable Timestamp . . . . . . . . . . . . . . . . . . . . . . . . 9762
Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9763
Update Deadband:Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9763
Update Deadband:Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9764
Update Deadband:User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9765
VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9765
VI Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9766
Abort VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9772
Adapt Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9773
Block Diagram:Clean Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9774
Block Diagram:Get Image Scaled . . . . . . . . . . . . . . . . . . . . . . . . . 9775
Block Diagram:Remove Bad Wires . . . . . . . . . . . . . . . . . . . . . . . . 9778
Clear History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9778
Compile:VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9779
Configure Panel As Top-Level Hidden . . . . . . . . . . . . . . . . . . . . . 9781
Control VI Apply Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9782
Control Value:Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9783
Control Value:Get All . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9784
Control Value:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9785
Create from Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9787
Create from Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9789
Debugging:Get Debug Button Display State . . . . . . . . . . . . . . . . 9790
Debugging:Step Into . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9792
Debugging:Step Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9792
Debugging:Step Over . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9793
Default Values:Make Current Default . . . . . . . . . . . . . . . . . . . . . . 9794

258 ni.com
LabVIEW Programming Reference Manual

Default Values:Reinitialize All To Default. . . . . . . . . . . . . . . . . . . 9795


Detect Parallel Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9796
Disconnect From Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9797
Empty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9797
Find Control with Key Focus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9798
Front Panel:Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9799
Front Panel:Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9800
Front Panel:Get Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9801
Front Panel:Get Image Scaled . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9804
Front Panel:Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9807
Front Panel:Run-Time Position:Centered . . . . . . . . . . . . . . . . . . 9809
Front Panel:Run-Time Position:Custom . . . . . . . . . . . . . . . . . . . 9810
Front Panel:Run-Time Position:Get Position . . . . . . . . . . . . . . . 9812
Front Panel:Run-Time Position:Maximized . . . . . . . . . . . . . . . . 9814
Front Panel:Run-Time Position:Minimized . . . . . . . . . . . . . . . . . 9815
Front Panel:Run-Time Position:Unchanged . . . . . . . . . . . . . . . . 9816
Get Compile Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9817
Get Conpane Image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9818
Get Control Index by Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9819
Get Library Access Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9820
Get ObjectRef From BookmarkID . . . . . . . . . . . . . . . . . . . . . . . . . 9821
Get VI Bookmarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9822
Get VI Dependencies (Names and Paths) . . . . . . . . . . . . . . . . . . 9823
Lock State:Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9827
Lock State:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9828
Move Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9830
Pause VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9831
Populate Asynchronous Call Pool . . . . . . . . . . . . . . . . . . . . . . . . . 9831
Print:Panel To PostScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9833
Print:Panel To Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9834
Print:VI To HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9835
Print:VI To Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9838
Print:VI To RTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9840
Print:VI To Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9843
Remote Panel:Client Connections . . . . . . . . . . . . . . . . . . . . . . . . 9845
Remote Panel:Close Connection To Client . . . . . . . . . . . . . . . . . 9847

© National Instruments 259


LabVIEW Programming Reference Manual

Remote Panel:Lock Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9848


Remote Panel:Unlock Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9849
Replicate Conpane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9850
Revert VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9851
Run VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9852
Save:For Previous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9854
Save:Instrument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9856
Save:Run-Time Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9857
Transaction:Begin Undo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9858
Transaction:End Undo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9859
Transaction:Fail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9860
Transaction:Get Redo State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9860
Transaction:Get Undo State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9861
Transaction:Redo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9862
Transaction:Undo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9863
VI Icon:Get As Image Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9864
VI Icon:Save To File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9869
VI Icon:Set From File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9871
VI Icon:Set From Image Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9872
VI Strings:Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9877
VI Strings:Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9879
VI Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9880
Auto Logging:Log File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9888
Auto Logging:Log at Finish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9889
Auto Logging:Print at Finish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9890
Auto Preallocate Arrays and Strings . . . . . . . . . . . . . . . . . . . . . . . 9891
Automatic Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9892
Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9893
Block Diagram Window:Alignment Grid Size . . . . . . . . . . . . . . . 9894
Block Diagram Window:Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9895
Block Diagram Window:Origin . . . . . . . . . . . . . . . . . . . . . . . . . . . 9896
Block Diagram Window:State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9896
Block Diagram Window:Window Bounds . . . . . . . . . . . . . . . . . . 9897
Callers' Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9898
Compiled:Code Complexity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9899
Compiled:Last Compiled With . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9900

260 ni.com
LabVIEW Programming Reference Manual

Connector Pane:DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9901


Connector Pane:Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9902
Connector Pane:Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9903
Contains Compiled Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9904
Control VI Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9905
Edit Mode On Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9905
Execution Highlighting? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9906
Execution:Allow Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9907
Execution:Close After Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9908
Execution:Inline Is Allowed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9909
Execution:Inline SubVI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9910
Execution:Is Reentrant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9911
Execution:Preferred Exec System . . . . . . . . . . . . . . . . . . . . . . . . . 9911
Execution:Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9912
Execution:Reentrancy Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9913
Execution:Retain Wire Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9914
Execution:Run When Opened . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9915
Execution:Show Front Panel On Call . . . . . . . . . . . . . . . . . . . . . . 9916
Execution:Show Front Panel On Load . . . . . . . . . . . . . . . . . . . . . 9917
Execution:State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9918
Execution:Suspend On Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9919
Expand When Dropped As SubVI . . . . . . . . . . . . . . . . . . . . . . . . . . 9920
Front Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9920
Front Panel Window:Alignment Grid Size . . . . . . . . . . . . . . . . . . 9921
Front Panel Window:Allow Runtime PopUp . . . . . . . . . . . . . . . . 9922
Front Panel Window:Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9923
Front Panel Window:Closeable . . . . . . . . . . . . . . . . . . . . . . . . . . . 9924
Front Panel Window:Custom Title . . . . . . . . . . . . . . . . . . . . . . . . 9925
Front Panel Window:Highlight Return Button . . . . . . . . . . . . . . 9925
Front Panel Window:Is Frontmost . . . . . . . . . . . . . . . . . . . . . . . . 9926
Front Panel Window:Keep Window Proportions . . . . . . . . . . . . 9927
Front Panel Window:Minimizable . . . . . . . . . . . . . . . . . . . . . . . . . 9928
Front Panel Window:Minimum Size . . . . . . . . . . . . . . . . . . . . . . . 9929
Front Panel Window:Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9930
Front Panel Window:OldResizable . . . . . . . . . . . . . . . . . . . . . . . . 9931
Front Panel Window:Panel Bounds . . . . . . . . . . . . . . . . . . . . . . . 9932

© National Instruments 261


LabVIEW Programming Reference Manual

Front Panel Window:Resizable . . . . . . . . . . . . . . . . . . . . . . . . . . . 9934


Front Panel Window:Run VI Transparently . . . . . . . . . . . . . . . . . 9935
Front Panel Window:Show Menu Bar . . . . . . . . . . . . . . . . . . . . . . 9935
Front Panel Window:State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9936
Front Panel Window:Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9938
Front Panel Window:Title Bar Visible . . . . . . . . . . . . . . . . . . . . . . 9939
Front Panel Window:Transparency. . . . . . . . . . . . . . . . . . . . . . . . 9940
Front Panel Window:Window Bounds . . . . . . . . . . . . . . . . . . . . . 9940
Help:Document Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9942
Help:Document Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9943
Help:Document Web URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9944
Help:Use Web URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9945
History:Always Add Comments At Save. . . . . . . . . . . . . . . . . . . . 9946
History:Entire Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9947
History:Prompt for Comments At Close . . . . . . . . . . . . . . . . . . . 9947
History:Prompt for Comments At Save . . . . . . . . . . . . . . . . . . . . 9948
History:Record Application Comments . . . . . . . . . . . . . . . . . . . . 9949
History:Revision Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9950
History:Use Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9951
Is Clone VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9952
Is In Packed Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9953
Is Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9953
Is Probe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9954
Is Running Interactively. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9955
Is VI Paused? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9956
Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9956
Library:Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9957
Metrics:Block Diagram Loaded . . . . . . . . . . . . . . . . . . . . . . . . . . . 9958
Metrics:Code Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9959
Metrics:Front Panel Loaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9960
Metrics:Size of Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9961
Metrics:Size of Front Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9961
Metrics:Total Data Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9962
Modifications:Block Diagram Mods Bitset . . . . . . . . . . . . . . . . . 9963
Modifications:Front Panel Mods Bitset . . . . . . . . . . . . . . . . . . . . 9964
Modifications:VI Modifications Bitset . . . . . . . . . . . . . . . . . . . . . . 9965

262 ni.com
LabVIEW Programming Reference Manual

Owning Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9966


Printing:Block Diagram Scaling? . . . . . . . . . . . . . . . . . . . . . . . . . . 9967
Printing:Front Panel Scaling?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9967
Printing:Header Content:Date Printed? . . . . . . . . . . . . . . . . . . . 9968
Printing:Header Content:Modify Date? . . . . . . . . . . . . . . . . . . . . 9969
Printing:Header Content:Page Number? . . . . . . . . . . . . . . . . . . 9970
Printing:Header Content:VI Icon? . . . . . . . . . . . . . . . . . . . . . . . . . 9971
Printing:Header Content:VI Name? . . . . . . . . . . . . . . . . . . . . . . . 9972
Printing:Header Content:VI Path? . . . . . . . . . . . . . . . . . . . . . . . . . 9972
Printing:Margins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9973
Printing:Page Headers? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9974
Printing:Page Orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9975
Run-Time Menu Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9976
Terminal Bounds[] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9977
Tool Bar:Show Abort Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9978
Tool Bar:Show Free Run Button . . . . . . . . . . . . . . . . . . . . . . . . . . 9979
Tool Bar:Show Run Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9980
Tool Bar:Visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9981
VI Clone Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9982
VI Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9983
VI Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9983
VI Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9984
VI Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9985
VI Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9986
BD Selection Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9987
Key Down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9988
Key Down? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9990
Key Repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9992
Key Repeat? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9994
Key Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9996
Menu Activation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9997
Menu Selection (App) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9998
Menu Selection (User) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10000
Menu Selection? (App). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10001
Mouse Enter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10002
Mouse Leave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10002

© National Instruments 263


LabVIEW Programming Reference Manual

Panel Close. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10003


Panel Close? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10004
Panel Resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10005
PolymorphicVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10007
PolymorphicVI Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10007
GetPolyCHImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10007
PolymorphicVI Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10008
Adapt To Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10009
Draw Instance Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10010
InstanceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10010
Show Selector By Default . . . . . . . . . . . . . . . . . . . . . . . . . . 10011
FacadeVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10012
FacadeVI Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10012
Data Change. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10013
Direction Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10014
Display State Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10014
Exec State Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10015
MethodVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10016
SubsystemVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10016
VISA Resource Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10016
Event Class Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10017
Clear Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10017
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10018
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10018
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10019
Version Information:Resource Manufacturer Identification . . . . . . .
10019
Version Information:Resource Manufacturer Name . . . . . . . . 10020
Version Information:Version of Implementation . . . . . . . . . . . 10020
Version Information:Version of Specification. . . . . . . . . . . . . . 10021
Generic Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10021
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10023
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10023
Event Information:Interrupt Status ID . . . . . . . . . . . . . . . . . . . . 10024
Event Information:PXI/PCI Received Interrupt Data . . . . . . . . 10025
Event Information:PXI/PCI Received Interrupt Sequence . . . 10025

264 ni.com
LabVIEW Programming Reference Manual

Event Information:Received CIC State . . . . . . . . . . . . . . . . . . . . 10026


Event Information:Received Interrupt Level . . . . . . . . . . . . . . 10026
Event Information:Received Trigger ID . . . . . . . . . . . . . . . . . . . 10026
Event Information:Signal Processor Status ID . . . . . . . . . . . . . 10027
Event Information:Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10028
Event Information:USB Received Interrupt Size . . . . . . . . . . . 10028
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10029
Version Information:Resource Manufacturer Identification . . . . . . .
10029
Version Information:Resource Manufacturer Name . . . . . . . . 10029
Version Information:Version of Implementation . . . . . . . . . . . 10030
Version Information:Version of Specification. . . . . . . . . . . . . . 10030
GPIB CIC Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10031
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10031
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10032
Event Information:Received CIC State . . . . . . . . . . . . . . . . . . . . 10033
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10033
Version Information:Resource Manufacturer Identification . . . . . . .
10033
Version Information:Resource Manufacturer Name . . . . . . . . 10034
Version Information:Version of Implementation . . . . . . . . . . . 10034
Version Information:Version of Specification. . . . . . . . . . . . . . 10035
GPIB Listen Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10035
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10036
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10036
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10037
Version Information:Resource Manufacturer Identification . . . . . . .
10037
Version Information:Resource Manufacturer Name . . . . . . . . 10038
Version Information:Version of Implementation . . . . . . . . . . . 10038
Version Information:Version of Specification. . . . . . . . . . . . . . 10039
GPIB Talk Event Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10039
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10040
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10040
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10041
Version Information:Resource Manufacturer Identification . . . . . . .

© National Instruments 265


LabVIEW Programming Reference Manual

10041
Version Information:Resource Manufacturer Name . . . . . . . . 10042
Version Information:Version of Implementation . . . . . . . . . . . 10042
Version Information:Version of Specification. . . . . . . . . . . . . . 10043
PXI Interrupt Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10043
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10044
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10044
Event Information:PXI/PCI Received Interrupt Data . . . . . . . . 10045
Event Information:PXI/PCI Received Interrupt Sequence . . . 10046
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10046
Version Information:Resource Manufacturer Identification . . . . . . .
10046
Version Information:Resource Manufacturer Name . . . . . . . . 10047
Version Information:Version of Implementation . . . . . . . . . . . 10047
Version Information:Version of Specification. . . . . . . . . . . . . . 10048
Service Request Event Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10048
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10049
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10049
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10050
Version Information:Resource Manufacturer Identification . . . . . . .
10050
Version Information:Resource Manufacturer Name . . . . . . . . 10051
Version Information:Version of Implementation . . . . . . . . . . . 10051
Version Information:Version of Specification. . . . . . . . . . . . . . 10052
Trigger Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10052
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10053
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10053
Event Information:Received Trigger ID . . . . . . . . . . . . . . . . . . . 10054
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10055
Version Information:Resource Manufacturer Identification . . . . . . .
10055
Version Information:Resource Manufacturer Name . . . . . . . . 10056
Version Information:Version of Implementation . . . . . . . . . . . 10056
Version Information:Version of Specification. . . . . . . . . . . . . . 10057
USB Interrupt Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10057
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10058

266 ni.com
LabVIEW Programming Reference Manual

Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10058


Event Information:Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10060
Event Information:USB Received Interrupt Size . . . . . . . . . . . 10060
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10060
Version Information:Resource Manufacturer Identification . . . . . . .
10061
Version Information:Resource Manufacturer Name . . . . . . . . 10061
Version Information:Version of Implementation . . . . . . . . . . . 10062
Version Information:Version of Specification. . . . . . . . . . . . . . 10062
VXI Signal Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10063
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10063
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10063
Event Information:Signal Processor Status ID . . . . . . . . . . . . . 10065
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10065
Version Information:Resource Manufacturer Identification . . . . . . .
10065
Version Information:Resource Manufacturer Name . . . . . . . . 10066
Version Information:Version of Implementation . . . . . . . . . . . 10066
Version Information:Version of Specification. . . . . . . . . . . . . . 10067
VXI/VME Interrupt Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10067
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10068
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10068
Event Information:Interrupt Status ID . . . . . . . . . . . . . . . . . . . . 10069
Event Information:Received Interrupt Level . . . . . . . . . . . . . . 10070
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10070
Version Information:Resource Manufacturer Identification . . . . . . .
10070
Version Information:Resource Manufacturer Name . . . . . . . . 10071
Version Information:Version of Implementation . . . . . . . . . . . 10071
Version Information:Version of Specification. . . . . . . . . . . . . . 10072
VXI/VME Sysfail Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10072
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10073
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10073
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10074
Version Information:Resource Manufacturer Identification . . . . . . .
10074

© National Instruments 267


LabVIEW Programming Reference Manual

Version Information:Resource Manufacturer Name . . . . . . . . 10075


Version Information:Version of Implementation . . . . . . . . . . . 10075
Version Information:Version of Specification. . . . . . . . . . . . . . 10076
VXI/VME Sysreset Event Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10076
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10077
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 10077
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10078
Version Information:Resource Manufacturer Identification . . . . . . .
10078
Version Information:Resource Manufacturer Name . . . . . . . . 10079
Version Information:Version of Implementation . . . . . . . . . . . 10079
Version Information:Version of Specification. . . . . . . . . . . . . . 10080
Event Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10080
Event Information:Event Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10080
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10081
Version Information:Resource Manufacturer Identification . . . . . . 10081
Version Information:Resource Manufacturer Name . . . . . . . . . . . . . 10082
Version Information:Version of Implementation. . . . . . . . . . . . . . . . 10082
Version Information:Version of Specification . . . . . . . . . . . . . . . . . . 10083
I/O Session Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10083
FireWire Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10085
FireWire Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10087
FireWire Settings:Destination Upper Offset . . . . . . . . . . . . . . . 10087
FireWire Settings:Lower Chip ID . . . . . . . . . . . . . . . . . . . . . . . . . 10088
FireWire Settings:Source Upper Offset . . . . . . . . . . . . . . . . . . . 10088
FireWire Settings:Upper Chip ID . . . . . . . . . . . . . . . . . . . . . . . . . 10089
FireWire Settings:Vendor ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10089
FireWire Settings:Window Upper Offset . . . . . . . . . . . . . . . . . . 10089
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10090
General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10090
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10090
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10091
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10091
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10092
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10092
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10093

268 ni.com
LabVIEW Programming Reference Manual

General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10093


Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10094
Interface Information:Interface Description . . . . . . . . . . . . . . . 10094
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10094
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10095
Register Based Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10095
Register Based Settings:Destination Increment Count . . . . . 10096
Register Based Settings:Source Increment Count . . . . . . . . . 10096
Register Based Settings:Window Access . . . . . . . . . . . . . . . . . . 10097
Register Based Settings:Window Base Address . . . . . . . . . . . . 10097
Register Based Settings:Window Size . . . . . . . . . . . . . . . . . . . . 10098
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10098
Version Information:Resource Manufacturer Identification . . . . . . .
10098
Version Information:Resource Manufacturer Name . . . . . . . . 10099
Version Information:Version of Implementation . . . . . . . . . . . 10099
Version Information:Version of Specification. . . . . . . . . . . . . . 10100
GPIB BoardInterface Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10100
GPIB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10103
GPIB Settings:Addressed State . . . . . . . . . . . . . . . . . . . . . . . . . . 10104
GPIB Settings:HS488 Cable Length. . . . . . . . . . . . . . . . . . . . . . . 10104
GPIB Settings:Is Controller In Charge. . . . . . . . . . . . . . . . . . . . . 10105
GPIB Settings:Line ATN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10105
GPIB Settings:Line NDAC State . . . . . . . . . . . . . . . . . . . . . . . . . . 10106
GPIB Settings:Line REN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10106
GPIB Settings:Line SRQ State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10107
GPIB Settings:Primary Address . . . . . . . . . . . . . . . . . . . . . . . . . . 10107
GPIB Settings:Secondary Address . . . . . . . . . . . . . . . . . . . . . . . 10108
GPIB Settings:System Controller State . . . . . . . . . . . . . . . . . . . 10108
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10108
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10109
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10109
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10110
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10110
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10111
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10111

© National Instruments 269


LabVIEW Programming Reference Manual

General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10112


Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10112
Interface Information:Interface Description . . . . . . . . . . . . . . . 10112
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10113
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10113
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10114
Message Based Settings:Device Status Byte . . . . . . . . . . . . . . . 10114
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10114
Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10115
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10115
Message Based Settings:Termination Character . . . . . . . . . . . 10116
Message Based Settings:Termination Character Enable . . . . 10117
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10117
Version Information:Resource Manufacturer Identification . . . . . . .
10117
Version Information:Resource Manufacturer Name . . . . . . . . 10118
Version Information:Version of Implementation . . . . . . . . . . . 10118
Version Information:Version of Specification. . . . . . . . . . . . . . 10119
GPIB Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10119
GPIB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10122
GPIB Settings:Line REN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10122
GPIB Settings:Primary Address . . . . . . . . . . . . . . . . . . . . . . . . . . 10122
GPIB Settings:Readdressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10123
GPIB Settings:Secondary Address . . . . . . . . . . . . . . . . . . . . . . . 10123
GPIB Settings:Unaddressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10124
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10124
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10124
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10125
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10125
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10126
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10126
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10127
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10127
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10127
Interface Information:Interface Description . . . . . . . . . . . . . . . 10128
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10128

270 ni.com
LabVIEW Programming Reference Manual

Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10128


Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10129
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10129
Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10130
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10130
Message Based Settings:Termination Character . . . . . . . . . . . 10131
Message Based Settings:Termination Character Enable . . . . 10132
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10132
Version Information:Resource Manufacturer Identification . . . . . . .
10132
Version Information:Resource Manufacturer Name . . . . . . . . 10133
Version Information:Version of Implementation . . . . . . . . . . . 10133
Version Information:Version of Specification. . . . . . . . . . . . . . 10134
Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10134
FireWire Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10148
FireWire Settings:Destination Upper Offset . . . . . . . . . . . . . . . 10148
FireWire Settings:Lower Chip ID . . . . . . . . . . . . . . . . . . . . . . . . . 10148
FireWire Settings:Source Upper Offset . . . . . . . . . . . . . . . . . . . 10149
FireWire Settings:Upper Chip ID . . . . . . . . . . . . . . . . . . . . . . . . . 10149
FireWire Settings:Vendor ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10150
FireWire Settings:Window Upper Offset . . . . . . . . . . . . . . . . . . 10150
GPIB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10150
GPIB Settings:Line REN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10151
GPIB Settings:Primary Address . . . . . . . . . . . . . . . . . . . . . . . . . . 10151
GPIB Settings:Readdressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10152
GPIB Settings:Secondary Address . . . . . . . . . . . . . . . . . . . . . . . 10152
GPIB Settings:Unaddressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10152
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10153
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10153
General Settings:Manufacturer Identification . . . . . . . . . . . . . 10153
General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10154
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10154
General Settings:Model Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 10155
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10155
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10156
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10156

© National Instruments 271


LabVIEW Programming Reference Manual

General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10157


General Settings:Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10157
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10158
General Settings:Trigger Identifier . . . . . . . . . . . . . . . . . . . . . . . 10158
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10159
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10160
Interface Information:Interface Description . . . . . . . . . . . . . . . 10160
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10160
Interface Information:Interface Number of Parent . . . . . . . . . 10161
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10161
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10162
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10162
Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10163
Message Based Settings:Is 488.2 Compliant . . . . . . . . . . . . . . 10163
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10164
Message Based Settings:Suppress End Enable . . . . . . . . . . . . 10164
Message Based Settings:Termination Character . . . . . . . . . . . 10165
Message Based Settings:Termination Character Enable . . . . 10166
PXI/PCI Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10166
PXI/PCI Settings:Allow Write Combining . . . . . . . . . . . . . . . . . . 10166
Express Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10167
PXI/PCI Settings:Express Settings:Actual Link Width . . 10167
PXI/PCI Settings:Express Settings:D-Star Bus Number. . . . . . .
10167
PXI/PCI Settings:Express Settings:D-Star Set . . . . . . . . . 10168
PXI/PCI Settings:Express Settings:Is PCI Express . . . . . . 10168
PXI/PCI Settings:Express Settings:Maximum Link Width . . . . .
10169
PXI/PCI Settings:Express Settings:Slot Link Width . . . . 10169
PXI/PCI Settings:PCI Bus Number . . . . . . . . . . . . . . . . . . . . . . . . 10170
PXI/PCI Settings:PCI Device Number . . . . . . . . . . . . . . . . . . . . . 10170
PXI/PCI Settings:PCI Function Number . . . . . . . . . . . . . . . . . . . 10170
PCI Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10171
PXI/PCI Settings:PCI Resources:BAR0 Address Base . . . 10171
PXI/PCI Settings:PCI Resources:BAR0 Address Size . . . 10171
PXI/PCI Settings:PCI Resources:BAR0 Address Type . . . 10172

272 ni.com
LabVIEW Programming Reference Manual

PXI/PCI Settings:PCI Resources:BAR1 Address Base . . . 10173


PXI/PCI Settings:PCI Resources:BAR1 Address Size . . . 10173
PXI/PCI Settings:PCI Resources:BAR1 Address Type . . . 10174
PXI/PCI Settings:PCI Resources:BAR2 Address Base . . . 10174
PXI/PCI Settings:PCI Resources:BAR2 Address Size . . . 10175
PXI/PCI Settings:PCI Resources:BAR2 Address Type . . . 10175
PXI/PCI Settings:PCI Resources:BAR3 Address Base . . . 10176
PXI/PCI Settings:PCI Resources:BAR3 Address Size . . . 10176
PXI/PCI Settings:PCI Resources:BAR3 Address Type . . . 10177
PXI/PCI Settings:PCI Resources:BAR4 Address Base . . . 10178
PXI/PCI Settings:PCI Resources:BAR4 Address Size . . . 10178
PXI/PCI Settings:PCI Resources:BAR4 Address Type . . . 10179
PXI/PCI Settings:PCI Resources:BAR5 Address Base . . . 10179
PXI/PCI Settings:PCI Resources:BAR5 Address Size . . . 10180
PXI/PCI Settings:PCI Resources:BAR5 Address Type . . . 10180
PXI/PCI Settings:PXI Chassis Number . . . . . . . . . . . . . . . . . . . . 10181
PXI/PCI Settings:Slot Local Bus Left . . . . . . . . . . . . . . . . . . . . . . 10181
PXI/PCI Settings:Slot Local Bus Right. . . . . . . . . . . . . . . . . . . . . 10182
PXI/PCI Settings:Slot Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10182
PXI/PCI Settings:Star Trigger Bus Number . . . . . . . . . . . . . . . . 10183
PXI/PCI Settings:Star Trigger Line . . . . . . . . . . . . . . . . . . . . . . . . 10183
PXI/PCI Settings:Trigger Bus Number . . . . . . . . . . . . . . . . . . . . 10183
Register Based Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10184
Register Based Settings:Destination Increment Count . . . . . 10184
Register Based Settings:Source Increment Count . . . . . . . . . 10184
Register Based Settings:Window Access . . . . . . . . . . . . . . . . . . 10185
Register Based Settings:Window Base Address . . . . . . . . . . . . 10186
Register Based Settings:Window Size . . . . . . . . . . . . . . . . . . . . 10186
Serial Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10186
Serial Settings:Allow Transmit. . . . . . . . . . . . . . . . . . . . . . . . . . . 10187
Serial Settings:Baud Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10187
Serial Settings:Break Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10188
Serial Settings:Data Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10188
Serial Settings:Discard NUL Characters . . . . . . . . . . . . . . . . . . . 10189
Serial Settings:End Mode for Reads . . . . . . . . . . . . . . . . . . . . . . 10189
Serial Settings:End Mode for Writes . . . . . . . . . . . . . . . . . . . . . . 10190

© National Instruments 273


LabVIEW Programming Reference Manual

Serial Settings:Error Replacement Character . . . . . . . . . . . . . 10190


Serial Settings:Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10191
Serial Settings:Flow Control XOFF Character . . . . . . . . . . . . . . 10192
Serial Settings:Flow Control XON Character. . . . . . . . . . . . . . . 10192
Serial Settings:Is Port Connected . . . . . . . . . . . . . . . . . . . . . . . . 10193
Modem Line Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10193
Serial Settings:Modem Line Settings:Break State . . . . . 10193
Serial Settings:Modem Line Settings:Line CTS State . . 10194
Serial Settings:Modem Line Settings:Line DCD State . . 10194
Serial Settings:Modem Line Settings:Line DSR State . . 10195
Serial Settings:Modem Line Settings:Line DTR State . . 10196
Serial Settings:Modem Line Settings:Line RI State . . . . 10196
Serial Settings:Modem Line Settings:Line RTS State . . 10197
Serial Settings:Number of Bytes at Serial Port. . . . . . . . . . . . . 10198
Serial Settings:Parity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10198
Serial Settings:Stop Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10199
Serial Settings:Wire Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10199
TCP/IP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10200
TCP/IP Settings:Computer Hostname . . . . . . . . . . . . . . . . . . . . 10200
TCP/IP Settings:Dot-Notation Address . . . . . . . . . . . . . . . . . . . . 10201
HiSLIP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10201
TCP/IP Settings:HiSLIP Settings:Encryption Enabled . . 10201
TCP/IP Settings:HiSLIP Settings:Maximum Message KBytes. .
10202
TCP/IP Settings:HiSLIP Settings:Overlap Enabled. . . . . 10202
TCP/IP Settings:HiSLIP Settings:Protocol Version . . . . . 10203
TCP/IP Settings:HiSLIP Settings:SASL Mechanism . . . . 10203
TCP/IP Settings:Is HiSLIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10204
TCP/IP Settings:Keep-Alive Packets . . . . . . . . . . . . . . . . . . . . . . 10204
TCP/IP Settings:LAN Device Name . . . . . . . . . . . . . . . . . . . . . . . 10205
TCP/IP Settings:No Packet Delay . . . . . . . . . . . . . . . . . . . . . . . . . 10205
TCP/IP Settings:Server Certificate Expiration Date . . . . . . . . . 10206
TCP/IP Settings:Server Certificate Is Perpetual . . . . . . . . . . . . 10206
TCP/IP Settings:Server Certificate Issuer Name. . . . . . . . . . . . 10207
TCP/IP Settings:Server Certificate Subject Name . . . . . . . . . . 10207
TCP/IP Settings:TLS Cipher Suite . . . . . . . . . . . . . . . . . . . . . . . . 10208

274 ni.com
LabVIEW Programming Reference Manual

USB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10208


USB Settings:Maximum Interrupt Size . . . . . . . . . . . . . . . . . . . . 10208
USB Settings:Serial Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10209
USB Settings:USB Interface Number . . . . . . . . . . . . . . . . . . . . . 10209
USB Settings:USB Protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10209
VXI/VME Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10210
VXI/VME Settings:Destination Access Privilege . . . . . . . . . . . . 10210
VXI/VME Settings:Destination Byte Order . . . . . . . . . . . . . . . . . 10211
Fast Data Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10211
VXI/VME Settings:Fast Data Channel:Channel Mode. . . 10211
VXI/VME Settings:Fast Data Channel:Channel Number . . . . . .
10212
VXI/VME Settings:Fast Data Channel:Use Channel Pairs . . . . .
10212
VXI/VME Settings:Immediate Servant . . . . . . . . . . . . . . . . . . . . 10213
VXI/VME Settings:Mainframe Logical Address . . . . . . . . . . . . . 10213
VXI/VME Settings:Source Access Privilege . . . . . . . . . . . . . . . . . 10214
VXI/VME Settings:Source Byte Order . . . . . . . . . . . . . . . . . . . . . 10214
VXI/VME Settings:Supported VXI Trigger Lines. . . . . . . . . . . . . 10215
VXI/VME Settings:VXI Commander Logical Address . . . . . . . . 10216
VXI/VME Settings:VXI Device Class . . . . . . . . . . . . . . . . . . . . . . . 10216
VXI/VME Settings:VXI Logical Address . . . . . . . . . . . . . . . . . . . . 10217
VXI/VME Settings:VXI Memory Address Space . . . . . . . . . . . . . 10217
VXI/VME Settings:VXI Memory Base Address . . . . . . . . . . . . . . 10218
VXI/VME Settings:VXI Memory Size . . . . . . . . . . . . . . . . . . . . . . . 10218
VXI/VME Settings:VXI Trigger Directions . . . . . . . . . . . . . . . . . . 10219
VXI/VME Settings:VXI Trigger Lines Enable . . . . . . . . . . . . . . . . 10219
VXI/VME Settings:Window Access Privilege. . . . . . . . . . . . . . . . 10220
VXI/VME Settings:Window Byte Order . . . . . . . . . . . . . . . . . . . . 10220
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10221
Version Information:Resource Manufacturer Identification . . . . . . .
10221
Version Information:Resource Manufacturer Name . . . . . . . . 10222
Version Information:Version of Implementation . . . . . . . . . . . 10222
Version Information:Version of Specification. . . . . . . . . . . . . . 10223
PXI Backplane Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10223

© National Instruments 275


LabVIEW Programming Reference Manual

General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10226


General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10226
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10227
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10227
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10228
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10228
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10229
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10229
General Settings:Trigger Identifier . . . . . . . . . . . . . . . . . . . . . . . 10230
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10230
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10231
Interface Information:Interface Description . . . . . . . . . . . . . . . 10231
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10231
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10232
PXI/PCI Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10232
PXI/PCI Settings:Destination Trigger Bus Number . . . . . . . . . 10233
PXI/PCI Settings:PXI Chassis Number . . . . . . . . . . . . . . . . . . . . 10234
PXI/PCI Settings:Source Trigger Bus Number. . . . . . . . . . . . . . 10234
PXI/PCI Settings:Trigger Bus Number . . . . . . . . . . . . . . . . . . . . 10235
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10235
Version Information:Resource Manufacturer Identification . . . . . . .
10235
Version Information:Resource Manufacturer Name . . . . . . . . 10236
Version Information:Version of Implementation . . . . . . . . . . . 10236
Version Information:Version of Specification. . . . . . . . . . . . . . 10237
PXI Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10237
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10243
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10243
General Settings:Manufacturer Identification . . . . . . . . . . . . . 10244
General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10244
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10245
General Settings:Model Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 10245
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10246
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10246
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10247
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10247

276 ni.com
LabVIEW Programming Reference Manual

General Settings:Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10248


General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10248
General Settings:Trigger Identifier . . . . . . . . . . . . . . . . . . . . . . . 10249
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10249
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10250
Interface Information:Interface Description . . . . . . . . . . . . . . . 10250
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10250
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10251
PXI/PCI Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10251
Express Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10251
PXI/PCI Settings:Express Settings:Actual Link Width . . 10252
PXI/PCI Settings:Express Settings:D-Star Bus Number. . . . . . .
10252
PXI/PCI Settings:Express Settings:D-Star Set . . . . . . . . . 10253
PXI/PCI Settings:Express Settings:Is PCI Express . . . . . . 10253
PXI/PCI Settings:Express Settings:Maximum Link Width . . . . .
10254
PXI/PCI Settings:Express Settings:Slot Link Width . . . . 10254
PXI/PCI Settings:PCI Bus Number . . . . . . . . . . . . . . . . . . . . . . . . 10255
PXI/PCI Settings:PCI Device Number . . . . . . . . . . . . . . . . . . . . . 10255
PXI/PCI Settings:PCI Function Number . . . . . . . . . . . . . . . . . . . 10255
PCI Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10256
PXI/PCI Settings:PCI Resources:BAR0 Address Base . . . 10256
PXI/PCI Settings:PCI Resources:BAR0 Address Size . . . 10256
PXI/PCI Settings:PCI Resources:BAR0 Address Type . . . 10257
PXI/PCI Settings:PCI Resources:BAR1 Address Base . . . 10258
PXI/PCI Settings:PCI Resources:BAR1 Address Size . . . 10258
PXI/PCI Settings:PCI Resources:BAR1 Address Type . . . 10259
PXI/PCI Settings:PCI Resources:BAR2 Address Base . . . 10259
PXI/PCI Settings:PCI Resources:BAR2 Address Size . . . 10260
PXI/PCI Settings:PCI Resources:BAR2 Address Type . . . 10260
PXI/PCI Settings:PCI Resources:BAR3 Address Base . . . 10261
PXI/PCI Settings:PCI Resources:BAR3 Address Size . . . 10261
PXI/PCI Settings:PCI Resources:BAR3 Address Type . . . 10262
PXI/PCI Settings:PCI Resources:BAR4 Address Base . . . 10263
PXI/PCI Settings:PCI Resources:BAR4 Address Size . . . 10263

© National Instruments 277


LabVIEW Programming Reference Manual

PXI/PCI Settings:PCI Resources:BAR4 Address Type . . . 10264


PXI/PCI Settings:PCI Resources:BAR5 Address Base . . . 10264
PXI/PCI Settings:PCI Resources:BAR5 Address Size . . . 10265
PXI/PCI Settings:PCI Resources:BAR5 Address Type . . . 10265
PXI/PCI Settings:PXI Chassis Number . . . . . . . . . . . . . . . . . . . . 10266
PXI/PCI Settings:Slot Local Bus Left . . . . . . . . . . . . . . . . . . . . . . 10266
PXI/PCI Settings:Slot Local Bus Right. . . . . . . . . . . . . . . . . . . . . 10267
PXI/PCI Settings:Slot Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10267
PXI/PCI Settings:Star Trigger Bus Number . . . . . . . . . . . . . . . . 10268
PXI/PCI Settings:Star Trigger Line . . . . . . . . . . . . . . . . . . . . . . . . 10268
PXI/PCI Settings:Trigger Bus Number . . . . . . . . . . . . . . . . . . . . 10268
Register Based Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10269
Register Based Settings:Destination Increment Count . . . . . 10269
Register Based Settings:Source Increment Count . . . . . . . . . 10269
Register Based Settings:Window Access . . . . . . . . . . . . . . . . . . 10270
Register Based Settings:Window Base Address . . . . . . . . . . . . 10271
Register Based Settings:Window Size . . . . . . . . . . . . . . . . . . . . 10271
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10271
Version Information:Resource Manufacturer Identification . . . . . . .
10272
Version Information:Resource Manufacturer Name . . . . . . . . 10272
Version Information:Version of Implementation . . . . . . . . . . . 10273
Version Information:Version of Specification. . . . . . . . . . . . . . 10273
PXI MemAcc Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10274
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10275
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10276
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10276
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10277
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10277
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10278
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10278
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10278
Interface Information:Interface Description . . . . . . . . . . . . . . . 10279
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10279
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10279
Register Based Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10280

278 ni.com
LabVIEW Programming Reference Manual

Register Based Settings:Destination Increment Count . . . . . 10280


Register Based Settings:Source Increment Count . . . . . . . . . 10281
Register Based Settings:Window Access . . . . . . . . . . . . . . . . . . 10281
Register Based Settings:Window Base Address . . . . . . . . . . . . 10282
Register Based Settings:Window Size . . . . . . . . . . . . . . . . . . . . 10282
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10283
Version Information:Resource Manufacturer Identification . . . . . . .
10283
Version Information:Resource Manufacturer Name . . . . . . . . 10283
Version Information:Version of Implementation . . . . . . . . . . . 10284
Version Information:Version of Specification. . . . . . . . . . . . . . 10284
Serial Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10285
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10290
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10290
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10291
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10291
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10292
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10292
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10293
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10293
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10293
Interface Information:Interface Description . . . . . . . . . . . . . . . 10294
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10294
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10294
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10295
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10295
Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10296
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10296
Message Based Settings:Suppress End Enable . . . . . . . . . . . . 10297
Message Based Settings:Termination Character . . . . . . . . . . . 10298
Message Based Settings:Termination Character Enable . . . . 10298
Serial Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10299
Serial Settings:Allow Transmit. . . . . . . . . . . . . . . . . . . . . . . . . . . 10299
Serial Settings:Baud Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10299
Serial Settings:Break Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10300
Serial Settings:Data Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10300

© National Instruments 279


LabVIEW Programming Reference Manual

Serial Settings:Discard NUL Characters . . . . . . . . . . . . . . . . . . . 10301


Serial Settings:End Mode for Reads . . . . . . . . . . . . . . . . . . . . . . 10301
Serial Settings:End Mode for Writes . . . . . . . . . . . . . . . . . . . . . . 10302
Serial Settings:Error Replacement Character . . . . . . . . . . . . . 10303
Serial Settings:Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10303
Serial Settings:Flow Control XOFF Character . . . . . . . . . . . . . . 10304
Serial Settings:Flow Control XON Character. . . . . . . . . . . . . . . 10304
Serial Settings:Is Port Connected . . . . . . . . . . . . . . . . . . . . . . . . 10305
Modem Line Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10305
Serial Settings:Modem Line Settings:Break State . . . . . 10305
Serial Settings:Modem Line Settings:Line CTS State . . 10306
Serial Settings:Modem Line Settings:Line DCD State . . 10307
Serial Settings:Modem Line Settings:Line DSR State . . 10307
Serial Settings:Modem Line Settings:Line DTR State . . 10308
Serial Settings:Modem Line Settings:Line RI State . . . . 10309
Serial Settings:Modem Line Settings:Line RTS State . . 10309
Serial Settings:Number of Bytes at Serial Port. . . . . . . . . . . . . 10310
Serial Settings:Parity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10310
Serial Settings:Stop Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10311
Serial Settings:Wire Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10312
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10312
Version Information:Resource Manufacturer Identification . . . . . . .
10313
Version Information:Resource Manufacturer Name . . . . . . . . 10313
Version Information:Version of Implementation . . . . . . . . . . . 10314
Version Information:Version of Specification. . . . . . . . . . . . . . 10314
TCP/IP Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10315
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10317
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10317
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10318
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10318
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10319
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10319
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10320
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10320
Interface Information:Interface Description . . . . . . . . . . . . . . . 10320

280 ni.com
LabVIEW Programming Reference Manual

Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10321


Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10321
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10322
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10322
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10322
Message Based Settings:Termination Character . . . . . . . . . . . 10323
Message Based Settings:Termination Character Enable . . . . 10323
TCP/IP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10324
TCP/IP Settings:Computer Hostname . . . . . . . . . . . . . . . . . . . . 10324
TCP/IP Settings:Dot-Notation Address . . . . . . . . . . . . . . . . . . . . 10324
TCP/IP Settings:Keep-Alive Packets . . . . . . . . . . . . . . . . . . . . . . 10325
TCP/IP Settings:LAN Device Name . . . . . . . . . . . . . . . . . . . . . . . 10325
TCP/IP Settings:No Packet Delay . . . . . . . . . . . . . . . . . . . . . . . . . 10326
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10326
Version Information:Resource Manufacturer Identification . . . . . . .
10326
Version Information:Resource Manufacturer Name . . . . . . . . 10327
Version Information:Version of Implementation . . . . . . . . . . . 10327
Version Information:Version of Specification. . . . . . . . . . . . . . 10328
TCP/IP Socket Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10328
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10332
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10332
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10332
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10333
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10333
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10334
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10334
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10335
Interface Information:Interface Description . . . . . . . . . . . . . . . 10335
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10335
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10336
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10336
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10337
Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10337
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10338
Message Based Settings:Suppress End Enable . . . . . . . . . . . . 10338

© National Instruments 281


LabVIEW Programming Reference Manual

Message Based Settings:Termination Character . . . . . . . . . . . 10339


Message Based Settings:Termination Character Enable . . . . 10340
TCP/IP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10340
TCP/IP Settings:Computer Hostname . . . . . . . . . . . . . . . . . . . . 10340
TCP/IP Settings:Dot-Notation Address . . . . . . . . . . . . . . . . . . . . 10341
TCP/IP Settings:Keep-Alive Packets . . . . . . . . . . . . . . . . . . . . . . 10341
TCP/IP Settings:No Packet Delay . . . . . . . . . . . . . . . . . . . . . . . . . 10342
TCP/IP Settings:Port Number. . . . . . . . . . . . . . . . . . . . . . . . . . . . 10342
TCP/IP Settings:Server Certificate Expiration Date . . . . . . . . . 10343
TCP/IP Settings:Server Certificate Is Perpetual . . . . . . . . . . . . 10343
TCP/IP Settings:Server Certificate Issuer Name. . . . . . . . . . . . 10344
TCP/IP Settings:Server Certificate Subject Name . . . . . . . . . . 10344
TCP/IP Settings:TLS Cipher Suite . . . . . . . . . . . . . . . . . . . . . . . . 10345
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10345
Version Information:Resource Manufacturer Identification . . . . . . .
10345
Version Information:Resource Manufacturer Name . . . . . . . . 10346
Version Information:Version of Implementation . . . . . . . . . . . 10346
Version Information:Version of Specification. . . . . . . . . . . . . . 10347
USB Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10347
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10350
General Settings:Manufacturer Identification . . . . . . . . . . . . . 10350
General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10351
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10351
General Settings:Model Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 10352
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10352
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10353
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10353
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10354
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10354
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10355
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10355
Interface Information:Interface Description . . . . . . . . . . . . . . . 10355
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10356
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10356
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10357

282 ni.com
LabVIEW Programming Reference Manual

Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10357


Message Based Settings:Is 488.2 Compliant . . . . . . . . . . . . . . 10357
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10358
Message Based Settings:Termination Character . . . . . . . . . . . 10359
Message Based Settings:Termination Character Enable . . . . 10359
USB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10359
USB Settings:Maximum Interrupt Size . . . . . . . . . . . . . . . . . . . . 10360
USB Settings:Serial Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10360
USB Settings:USB Interface Number . . . . . . . . . . . . . . . . . . . . . 10361
USB Settings:USB Protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10361
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10361
Version Information:Resource Manufacturer Identification . . . . . . .
10361
Version Information:Resource Manufacturer Name . . . . . . . . 10362
Version Information:Version of Implementation . . . . . . . . . . . 10363
Version Information:Version of Specification. . . . . . . . . . . . . . 10363
USB Raw Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10364
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10368
General Settings:Manufacturer Identification . . . . . . . . . . . . . 10368
General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10368
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10369
General Settings:Model Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 10369
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10370
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10370
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10371
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10371
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10372
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10372
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10372
Interface Information:Interface Description . . . . . . . . . . . . . . . 10373
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10373
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10373
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10374
Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10374
Message Based Settings:Suppress End Enable . . . . . . . . . . . . 10375
Message Based Settings:Termination Character . . . . . . . . . . . 10376

© National Instruments 283


LabVIEW Programming Reference Manual

Message Based Settings:Termination Character Enable . . . . 10376


USB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10377
USB Settings:Alternate Setting . . . . . . . . . . . . . . . . . . . . . . . . . . 10377
USB Settings:Bulk-In Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10377
USB Settings:Bulk-In Pipe Status . . . . . . . . . . . . . . . . . . . . . . . . 10378
USB Settings:Bulk-Out Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10378
USB Settings:Bulk-Out Pipe Status . . . . . . . . . . . . . . . . . . . . . . . 10379
USB Settings:Control Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10379
USB Settings:End Mode for Reads . . . . . . . . . . . . . . . . . . . . . . . 10380
USB Settings:Interrupt-In Pipe . . . . . . . . . . . . . . . . . . . . . . . . . . 10381
USB Settings:Interrupt-In Pipe Status . . . . . . . . . . . . . . . . . . . . 10381
USB Settings:Maximum Interrupt Size . . . . . . . . . . . . . . . . . . . . 10382
USB Settings:Number of Interfaces . . . . . . . . . . . . . . . . . . . . . . 10382
USB Settings:Number of Pipes . . . . . . . . . . . . . . . . . . . . . . . . . . 10383
USB Settings:Serial Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10383
USB Settings:USB Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10383
USB Settings:USB Interface Number . . . . . . . . . . . . . . . . . . . . . 10384
USB Settings:USB Protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10384
USB Settings:USB Subclass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10385
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10385
Version Information:Resource Manufacturer Identification . . . . . . .
10385
Version Information:Resource Manufacturer Name . . . . . . . . 10386
Version Information:Version of Implementation . . . . . . . . . . . 10386
Version Information:Version of Specification. . . . . . . . . . . . . . 10387
VXI Servant Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10387
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10390
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10390
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10390
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10391
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10391
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10392
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10392
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10393
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10393
Interface Information:Interface Description . . . . . . . . . . . . . . . 10393

284 ni.com
LabVIEW Programming Reference Manual

Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10394


Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10394
Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10395
Message Based Settings:Device Status Byte . . . . . . . . . . . . . . . 10395
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10395
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10396
Message Based Settings:Termination Character . . . . . . . . . . . 10396
Message Based Settings:Termination Character Enable . . . . 10397
VXI/VME Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10397
VXI/VME Settings:VXI Commander Logical Address . . . . . . . . 10397
VXI/VME Settings:VXI Logical Address . . . . . . . . . . . . . . . . . . . . 10398
VXI/VME Settings:VXI/VME System Failure State . . . . . . . . . . . 10398
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10399
Version Information:Resource Manufacturer Identification . . . . . . .
10399
Version Information:Resource Manufacturer Name . . . . . . . . 10399
Version Information:Version of Implementation . . . . . . . . . . . 10400
Version Information:Version of Specification. . . . . . . . . . . . . . 10401
VXI/GPIB-VXI Backplane Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10401
GPIB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10403
GPIB Settings:Primary Address . . . . . . . . . . . . . . . . . . . . . . . . . . 10403
GPIB Settings:Secondary Address . . . . . . . . . . . . . . . . . . . . . . . 10404
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10404
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10404
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10405
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10405
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10406
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10406
General Settings:Trigger Identifier . . . . . . . . . . . . . . . . . . . . . . . 10407
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10407
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10408
Interface Information:Interface Description . . . . . . . . . . . . . . . 10408
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10408
Interface Information:Interface Number of Parent . . . . . . . . . 10409
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10409
VXI/VME Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10410

© National Instruments 285


LabVIEW Programming Reference Manual

VXI/VME Settings:Asserted VXI Trigger Lines . . . . . . . . . . . . . . 10410


VXI/VME Settings:Asserted VXI/VME Interrupt Lines . . . . . . . . 10411
VXI/VME Settings:Mainframe Logical Address . . . . . . . . . . . . . 10411
VXI/VME Settings:Supported VXI Trigger Lines. . . . . . . . . . . . . 10412
VXI/VME Settings:VXI/VME System Failure State . . . . . . . . . . . 10412
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10413
Version Information:Resource Manufacturer Identification . . . . . . .
10413
Version Information:Resource Manufacturer Name . . . . . . . . 10413
Version Information:Version of Implementation . . . . . . . . . . . 10414
Version Information:Version of Specification. . . . . . . . . . . . . . 10414
VXI/GPIB-VXI MBD Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10415
GPIB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10421
GPIB Settings:Line REN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10421
GPIB Settings:Primary Address . . . . . . . . . . . . . . . . . . . . . . . . . . 10421
GPIB Settings:Readdressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10422
GPIB Settings:Secondary Address . . . . . . . . . . . . . . . . . . . . . . . 10422
GPIB Settings:Unaddressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10423
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10423
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10423
General Settings:Manufacturer Identification . . . . . . . . . . . . . 10424
General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10424
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10425
General Settings:Model Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 10425
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10426
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10426
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10427
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10427
General Settings:Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10428
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10428
General Settings:Trigger Identifier . . . . . . . . . . . . . . . . . . . . . . . 10429
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10429
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10430
Interface Information:Interface Description . . . . . . . . . . . . . . . 10430
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10430
Interface Information:Interface Number of Parent . . . . . . . . . 10431

286 ni.com
LabVIEW Programming Reference Manual

Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10431


Message Based Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10432
Message Based Settings:File Append Enable . . . . . . . . . . . . . . 10432
Message Based Settings:IO Protocol . . . . . . . . . . . . . . . . . . . . . 10433
Message Based Settings:Is 488.2 Compliant . . . . . . . . . . . . . . 10433
Message Based Settings:Send End Enable . . . . . . . . . . . . . . . . 10434
Message Based Settings:Suppress End Enable . . . . . . . . . . . . 10434
Message Based Settings:Termination Character . . . . . . . . . . . 10435
Message Based Settings:Termination Character Enable . . . . 10436
Register Based Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10436
Register Based Settings:Destination Increment Count . . . . . 10436
Register Based Settings:Source Increment Count . . . . . . . . . 10437
Register Based Settings:Window Access . . . . . . . . . . . . . . . . . . 10437
Register Based Settings:Window Base Address . . . . . . . . . . . . 10438
Register Based Settings:Window Size . . . . . . . . . . . . . . . . . . . . 10438
VXI/VME Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10439
VXI/VME Settings:Destination Access Privilege . . . . . . . . . . . . 10439
VXI/VME Settings:Destination Byte Order . . . . . . . . . . . . . . . . . 10440
Fast Data Channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10440
VXI/VME Settings:Fast Data Channel:Channel Mode. . . 10440
VXI/VME Settings:Fast Data Channel:Channel Number . . . . . .
10441
VXI/VME Settings:Fast Data Channel:Use Channel Pairs . . . . .
10441
VXI/VME Settings:Immediate Servant . . . . . . . . . . . . . . . . . . . . 10442
VXI/VME Settings:Mainframe Logical Address . . . . . . . . . . . . . 10442
VXI/VME Settings:Source Access Privilege . . . . . . . . . . . . . . . . . 10443
VXI/VME Settings:Source Byte Order . . . . . . . . . . . . . . . . . . . . . 10443
VXI/VME Settings:Supported VXI Trigger Lines. . . . . . . . . . . . . 10444
VXI/VME Settings:VXI Commander Logical Address . . . . . . . . 10445
VXI/VME Settings:VXI Device Class . . . . . . . . . . . . . . . . . . . . . . . 10445
VXI/VME Settings:VXI Logical Address . . . . . . . . . . . . . . . . . . . . 10446
VXI/VME Settings:VXI Memory Address Space . . . . . . . . . . . . . 10446
VXI/VME Settings:VXI Memory Base Address . . . . . . . . . . . . . . 10447
VXI/VME Settings:VXI Memory Size . . . . . . . . . . . . . . . . . . . . . . . 10447
VXI/VME Settings:VXI Trigger Directions . . . . . . . . . . . . . . . . . . 10448

© National Instruments 287


LabVIEW Programming Reference Manual

VXI/VME Settings:VXI Trigger Lines Enable . . . . . . . . . . . . . . . . 10448


VXI/VME Settings:Window Access Privilege. . . . . . . . . . . . . . . . 10449
VXI/VME Settings:Window Byte Order . . . . . . . . . . . . . . . . . . . . 10449
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10450
Version Information:Resource Manufacturer Identification . . . . . . .
10450
Version Information:Resource Manufacturer Name . . . . . . . . 10451
Version Information:Version of Implementation . . . . . . . . . . . 10451
Version Information:Version of Specification. . . . . . . . . . . . . . 10452
VXI/GPIB-VXI/VME MemAcc Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10452
GPIB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10455
GPIB Settings:Line REN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10455
GPIB Settings:Primary Address . . . . . . . . . . . . . . . . . . . . . . . . . . 10456
GPIB Settings:Secondary Address . . . . . . . . . . . . . . . . . . . . . . . 10456
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10456
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10457
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10457
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10458
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10458
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10459
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10459
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10460
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10460
Interface Information:Interface Description . . . . . . . . . . . . . . . 10460
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10461
Interface Information:Interface Number of Parent . . . . . . . . . 10461
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10461
Register Based Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10462
Register Based Settings:Destination Increment Count . . . . . 10462
Register Based Settings:Source Increment Count . . . . . . . . . 10463
Register Based Settings:Window Access . . . . . . . . . . . . . . . . . . 10463
Register Based Settings:Window Base Address . . . . . . . . . . . . 10464
Register Based Settings:Window Size . . . . . . . . . . . . . . . . . . . . 10464
VXI/VME Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10465
VXI/VME Settings:Destination Access Privilege . . . . . . . . . . . . 10465
VXI/VME Settings:Destination Byte Order . . . . . . . . . . . . . . . . . 10466

288 ni.com
LabVIEW Programming Reference Manual

VXI/VME Settings:Source Access Privilege . . . . . . . . . . . . . . . . . 10466


VXI/VME Settings:Source Byte Order . . . . . . . . . . . . . . . . . . . . . 10467
VXI/VME Settings:VXI Logical Address . . . . . . . . . . . . . . . . . . . . 10468
VXI/VME Settings:Window Access Privilege. . . . . . . . . . . . . . . . 10468
VXI/VME Settings:Window Byte Order . . . . . . . . . . . . . . . . . . . . 10469
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10469
Version Information:Resource Manufacturer Identification . . . . . . .
10469
Version Information:Resource Manufacturer Name . . . . . . . . 10470
Version Information:Version of Implementation . . . . . . . . . . . 10470
Version Information:Version of Specification. . . . . . . . . . . . . . 10471
VXI/GPIB-VXI/VME RBD Instr Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10471
GPIB Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10476
GPIB Settings:Line REN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10476
GPIB Settings:Primary Address . . . . . . . . . . . . . . . . . . . . . . . . . . 10476
GPIB Settings:Secondary Address . . . . . . . . . . . . . . . . . . . . . . . 10477
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10477
General Settings:Allow DMA Transfers . . . . . . . . . . . . . . . . . . . . 10477
General Settings:Manufacturer Identification . . . . . . . . . . . . . 10478
General Settings:Manufacturer Name . . . . . . . . . . . . . . . . . . . . 10478
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . 10479
General Settings:Model Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 10479
General Settings:Model Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 10480
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . 10480
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . 10481
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . 10481
General Settings:Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10482
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . 10482
General Settings:Trigger Identifier . . . . . . . . . . . . . . . . . . . . . . . 10483
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10484
Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10484
Interface Information:Interface Description . . . . . . . . . . . . . . . 10484
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . 10485
Interface Information:Interface Number of Parent . . . . . . . . . 10485
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . 10485
Register Based Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10486

© National Instruments 289


LabVIEW Programming Reference Manual

Register Based Settings:Destination Increment Count . . . . . 10486


Register Based Settings:Source Increment Count . . . . . . . . . 10487
Register Based Settings:Window Access . . . . . . . . . . . . . . . . . . 10487
Register Based Settings:Window Base Address . . . . . . . . . . . . 10488
Register Based Settings:Window Size . . . . . . . . . . . . . . . . . . . . 10488
VXI/VME Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10489
VXI/VME Settings:Destination Access Privilege . . . . . . . . . . . . 10489
VXI/VME Settings:Destination Byte Order . . . . . . . . . . . . . . . . . 10490
VXI/VME Settings:Immediate Servant . . . . . . . . . . . . . . . . . . . . 10490
VXI/VME Settings:Mainframe Logical Address . . . . . . . . . . . . . 10491
VXI/VME Settings:Source Access Privilege . . . . . . . . . . . . . . . . . 10491
VXI/VME Settings:Source Byte Order . . . . . . . . . . . . . . . . . . . . . 10492
VXI/VME Settings:Supported VXI Trigger Lines. . . . . . . . . . . . . 10492
VXI/VME Settings:VXI Commander Logical Address . . . . . . . . 10493
VXI/VME Settings:VXI Device Class . . . . . . . . . . . . . . . . . . . . . . . 10493
VXI/VME Settings:VXI Logical Address . . . . . . . . . . . . . . . . . . . . 10494
VXI/VME Settings:VXI Memory Address Space . . . . . . . . . . . . . 10494
VXI/VME Settings:VXI Memory Base Address . . . . . . . . . . . . . . 10495
VXI/VME Settings:VXI Memory Size . . . . . . . . . . . . . . . . . . . . . . . 10495
VXI/VME Settings:VXI Trigger Directions . . . . . . . . . . . . . . . . . . 10496
VXI/VME Settings:VXI Trigger Lines Enable . . . . . . . . . . . . . . . . 10496
VXI/VME Settings:Window Access Privilege. . . . . . . . . . . . . . . . 10497
VXI/VME Settings:Window Byte Order . . . . . . . . . . . . . . . . . . . . 10498
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10498
Version Information:Resource Manufacturer Identification . . . . . . .
10498
Version Information:Resource Manufacturer Name . . . . . . . . 10499
Version Information:Version of Implementation . . . . . . . . . . . 10499
Version Information:Version of Specification. . . . . . . . . . . . . . 10500
General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10500
General Settings:Maximum Queue Length . . . . . . . . . . . . . . . . . . . . . 10500
General Settings:Resource Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10501
General Settings:Resource Lock State . . . . . . . . . . . . . . . . . . . . . . . . . 10501
General Settings:Resource Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10502
General Settings:Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10502
General Settings:User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10503

290 ni.com
LabVIEW Programming Reference Manual

Interface Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10503


Interface Information:Interface Description . . . . . . . . . . . . . . . . . . . . 10503
Interface Information:Interface Number . . . . . . . . . . . . . . . . . . . . . . . 10504
Interface Information:Interface Type . . . . . . . . . . . . . . . . . . . . . . . . . . 10504
Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10505
Version Information:Resource Manufacturer Identification . . . . . . 10505
Version Information:Resource Manufacturer Name . . . . . . . . . . . . . 10505
Version Information:Version of Implementation. . . . . . . . . . . . . . . . 10506
Version Information:Version of Specification . . . . . . . . . . . . . . . . . . 10506
XML Parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10507
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10507
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10507
Element Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10507
Tag Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10507
Element Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10507
Get Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10509
Get Attribute NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10509
Get Attribute Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10510
Get Attribute Node NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10510
Get Elements By Tag Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10510
Get Elements By Tag Name Array . . . . . . . . . . . . . . . . . . . . . . . . 10511
Get Elements By Tag Name NS . . . . . . . . . . . . . . . . . . . . . . . . . . 10511
Get Elements By Tag Name NS Array . . . . . . . . . . . . . . . . . . . . . 10512
Has Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10512
Has Attribute NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10512
Remove Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10513
Remove Attribute NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10513
Remove Attribute Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10513
Set Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10514
Set Attribute NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10514
Set Attribute Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10515
Set Attribute Node NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10515
Set XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10515
Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10516
Attribute Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10516
Attribute Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10516

© National Instruments 291


LabVIEW Programming Reference Manual

Attribute Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10517


Explicitly Specified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10517
Owner Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10517
CharacterData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10518
Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10518
Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10518
CDATASection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10518
Text Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10518
Split Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10518
CharacterData Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10518
Character Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10519
Data Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10519
CharacterData Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10519
Append Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10520
Delete Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10520
Get Substring Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10521
Insert Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10521
Replace Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10521
ProcessingInstruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10522
ProcessingInstruction Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10522
PI Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10522
PI Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10522
DocumentFragment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10522
Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10523
Entity Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10523
Notation Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10523
Public ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10523
System ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10524
EntityReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10524
DocumentType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10524
DocumentType Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10524
DTD Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10524
Entities NamedNodeMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10525
Internal Subset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10525
Notations NamedNodeMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10526
Public ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10526

292 ni.com
LabVIEW Programming Reference Manual

System ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10526
Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10527
Document Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10527
Document Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10528
Document Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10528
Document Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10528
Load External DTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10529
Preserve Whitespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10529
Process Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10530
Process Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10530
Schema Full Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10530
Validate On Load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10531
XML Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10531
Document Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10532
Create Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10533
Create Attribute NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10533
Create CDATA Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10534
Create Comment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10534
Create Document Fragment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10535
Create Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10535
Create Element NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10535
Create Entity Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10536
Create Processing Instruction . . . . . . . . . . . . . . . . . . . . . . . . . . . 10536
Create Text Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10536
Get Element by ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10537
Get Elements By Tag Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10537
Get Elements By Tag Name Array . . . . . . . . . . . . . . . . . . . . . . . . 10537
Get Elements By Tag Name NS . . . . . . . . . . . . . . . . . . . . . . . . . . 10538
Get Elements By Tag Name NS Array . . . . . . . . . . . . . . . . . . . . . 10538
Import Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10538
Load File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10539
Load String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10539
Save File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10539
Save File (Pretty Print) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10540
Notation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10540
Notation Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10540

© National Instruments 293


LabVIEW Programming Reference Manual

Public ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10540
System ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10541
Node Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10541
Child Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10542
Child Nodes Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10542
Element Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10543
First Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10543
Last Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10543
Local Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10544
Namespace Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10544
Namespace URI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10544
Next Sibling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10545
Node Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10545
Node Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10545
Node Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10546
Owner Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10546
Parent Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10547
Previous Sibling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10547
Node Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10547
Append Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10548
Clone Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10548
Get XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10549
Get XML (Pretty Print) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10549
Has Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10549
Has Child Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10550
Insert Before . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10550
Is Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10550
Normalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10551
Remove Child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10551
Replace Child. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10551
Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10551
Implementation Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10551
Create Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10552
Create Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10552
Has Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10552
NamedNodeMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10553

294 ni.com
LabVIEW Programming Reference Manual

NamedNodeMap Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10553


Array Of Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10553
NamedNodeMap Length. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10553
NamedNodeMap Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10554
Get Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10554
Get Named Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10554
Get Named Item NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10555
Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10555
Remove Named Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10555
Remove Named Item NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10556
Set Named Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10556
Set Named Item NS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10556
NodeList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10557
NodeList Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10557
Array Of Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10557
List Length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10557
NodeList Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10558
Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10558
LabVIEW Environment Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10559
Edit Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10559
File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10561
Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10563
Operate Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10564
Project Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10565
Tools Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10567
View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10572
Window Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10574
Application Item Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10574
Application Item Tags for Shortcut Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10585
Reserved Application Item Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10588
Build Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10589
Project Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10590
Source Control Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10590
Standard Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10591
VI Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10591
Tools Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10593

© National Instruments 295


LabVIEW Programming Reference Manual

Tools Palette Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10594


Controls Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10595
Functions Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10596
User Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10597
Express User Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10597
Common Upgrade Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10597
Project Explorer Window Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10598
LabVIEW Dialog Box Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10601
3D Graph Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10601
Axes Page (3D Graph Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10601
Cursors Page (3D Graph Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . 10604
Format Page (3D Graph Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . 10608
Graph Page (3D Graph Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10608
Plots Page (3D Graph Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10610
Value Pairs Page (3D Graph Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 10616
3D Plot Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10618
Graph Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10618
Light Page (3D Plot Properties Dialog Box). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10621
Axis Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10622
Value Pair Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . 10626
Format Page (3D Plot Properties Dialog Box). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10627
Cursor Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10633
Bar Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10637
Comet Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10639
Contour Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10642
Mesh Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10646
Pie Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10649
Quiver Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10652
Ribbon Page (3D Plot Properties Dialog Box). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10655
Scatter Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10658
Stem Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10660
Surface Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10663
Waterfall Page (3D Plot Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . 10666
.NET Assemblies in Memory Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10669
.NET Interop Assembly Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10671
Additional Exclusions Page (.NET Interop Assembly Properties Dialog Box) . . . . . . .

296 ni.com
LabVIEW Programming Reference Manual

10672
Advanced Page (.NET Interop Assembly Properties Dialog Box) . . . . . . . . . . . . 10674
Destinations Page (.NET Interop Assembly Properties Dialog Box) . . . . . . . . . 10678
Information Page (.NET Interop Assembly Properties Dialog Box) . . . . . . . . . . 10680
Pre/Post Build Actions Page (.NET Interop Assembly Properties Dialog Box) . . . . . .
10681
Preview Page (.NET Interop Assembly Properties Dialog Box). . . . . . . . . . . . . . 10683
Run-Time Languages Page (.NET Interop Assembly Properties Dialog Box) . 10684
Source File Settings Page (.NET Interop Assembly Properties Dialog Box) . . . 10685
Source Files Page (.NET Interop Assembly Properties Dialog Box) . . . . . . . . . . 10689
Version Information Page (.NET Interop Assembly Properties Dialog Box). . . 10690
Windows Security Page (.NET Interop Assembly Properties Dialog Box) . . . . 10692
Add Targets and Devices Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10693
Add VI Hierarchy Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10695
All Windows Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10696
Add .NET Controls to Palette Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10697
Add ActiveX Controls to Palette Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10698
Add to Project and Update Dependencies Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . 10698
Application Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10699
Additional Exclusions Page (Application Properties Dialog Box). . . . . . . . . . . . 10700
Advanced Page (Application Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . 10702
Destinations Page (Application Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . 10707
Icon Page (Application Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . 10709
Information Page (Application Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . 10710
Pre/Post Build Actions Page (Application Properties Dialog Box) . . . . . . . . . . . 10711
Preview Page (Application Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . 10712
Run-Time Languages Page (Application Properties Dialog Box) . . . . . . . . . . . . 10713
Shared Variable Deployment Page (Application Properties Dialog Box) . . . . . 10714
Source File Settings Page (Application Properties Dialog Box) . . . . . . . . . . . . . 10715
Source Files Page (Application Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . 10719
Version Information Page (Application Properties Dialog Box) . . . . . . . . . . . . . 10721
Web Services Page (Application Properties Dialog box) . . . . . . . . . . . . . . . . . . . 10722
Windows Security Page (Application Properties Dialog Box) . . . . . . . . . . . . . . . 10724
Apply Icon Changes To Member VIs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10726
Authentication Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10726
Automatic Recovery Error Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10727

© National Instruments 297


LabVIEW Programming Reference Manual

Batch Variable Creation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10728


Bookmark Manager Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10729
Breakpoint Manager Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10730
Breakpoint Removal Summary Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10731
Browse for Variable Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10732
Browse Shared Variables Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10733
Browse Variable Object Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10734
Build Application from VI Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10734
Build Status Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10735
Build Unit String Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10736
Call Library Function Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10737
Change Parent Class Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10746
Change Parent Interfaces Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10747
Change Visible Palettes Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10748
Chart History Length Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10749
Choose Environment Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10749
Choose Implementation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10750
Class Browser Search Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10751
Class Browser Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10752
Class/Interface Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10754
Documentation Page (Class/Interface Properties Dialog Box) . . . . . . . . . . . . . . 10755
Friends Page (Class/Interface Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 10756
General Settings Page (Class/Interface Properties Dialog Box) . . . . . . . . . . . . . 10756
Inheritance Page (Class/Interface Properties Dialog Box). . . . . . . . . . . . . . . . . . 10758
Item Settings Page (Class/Interface Properties Dialog Box) . . . . . . . . . . . . . . . . 10759
Probes Page (Class/Interface Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . 10762
Protection Page (Class/Interface Properties Dialog Box) . . . . . . . . . . . . . . . . . . 10763
Wire Appearance Page (Class/Interface Properties Dialog Box). . . . . . . . . . . . . 10764
Clear Compiled Object Cache Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10766
Cluster Size Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10767
Colors Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10767
Color Ramp Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10767
Compare VI Hierarchies Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10768
Compare VIs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10771
Configuration Page (Shared Variable Node Properties Dialog Box) . . . . . . . . . . . . . . 10772
Configuration Page (Variable Refnum Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 10773

298 ni.com
LabVIEW Programming Reference Manual

Configure Advanced Excel Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10774


Configure Condition Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10777
Configure Fixed Point Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10781
Configure Fixed Point Dialog Box (Mixed Signal and Digital Waveform Graphs) . . . 10782
Configure Method Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10784
Configure Multi-file Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10785
Configure Next Frame Timing Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10788
Configure Next Iteration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10791
Configure RESTful VI Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10794
Configure Timed Loop Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10796
Configure Timed Loop with Frames Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10800
Configure Timed Sequence Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10805
Configure User Defined Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10809
Conflict Resolution Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10811
Connect to Remote Panel Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10812
Context Help Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10813
Control Parts Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10815
Conversion Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10817
Create Accessor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10817
Create Annotation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10819
Create Bound Variables Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10820
Create New Instrument Driver Project Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10822
Create New Probe Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10824
Create or Edit Express VI Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10825
Create Project Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10826
Create Property Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10828
Create Report Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10829
Customize Window Appearance Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10830
Data File Viewer Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10835
Debug Application or Shared Library Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10836
Define Signal Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10837
Define VI Prototype Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10839
Define VI Prototype Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10841
Description and Tip Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10843
Differences Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10844
Directories to Convert Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10846

© National Instruments 299


LabVIEW Programming Reference Manual

Edit Controls and Functions Palette Set Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10847


Edit Events Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10848
Edit Format String Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10850
Edit Instance Name Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10852
Edit Palette Item Name Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10852
Edit Scan String Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10853
Edit String Constant Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10854
Edit Tree Items Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10855
Error Code Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10856
Error List Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10857
Event Inspector Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10858
Explain Changes Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10860
Export Simplified Image Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10861
Express VI Creator Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10862
Convert VI Page (Express VI Creator Wizard) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10862
Copy Express VI Page (Express VI Creator Wizard) . . . . . . . . . . . . . . . . . . . . . . . . . 10863
Initialize Page (Express VI Creator Wizard) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10864
Setup Express VI Page (Express VI Creator Wizard) . . . . . . . . . . . . . . . . . . . . . . . . 10864
File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10865
File Viewer Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10866
Filter VISA Names Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10867
Find Callers Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10870
Find Children Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10870
Find Conflicts Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10871
Find Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10872
Find Friends Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10875
Find Items with No Callers Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10875
Find Missing Items Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10876
Find Parallelizable Loops Results Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10876
Find Project Items Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10878
Find SubVIs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10879
Find VIs on Disk Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10880
Font Style Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10881
For Loop Iteration Parallelism Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10883
Fuzzy System Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10885
Edit Description Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10890

300 ni.com
LabVIEW Programming Reference Manual

Edit Variable Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10891


Fuzzy System Designer Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10893
Pre-Generate Rules Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10894
Getting Started Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10895
Hierarchy Conflicts with Project Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10896
History Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10897
HTTP Method URL Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10898
Hyperlink Properties Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10899
Icon Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10900
Editing Tools in the Icon Editor Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10905
Icon Editor Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10906
Save Icon As Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10908
Synchronize Manually Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10909
Synchronize with Icon Library Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10909
Image to File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10910
Import Shared Library Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10911
Configure Include Paths and Preprocessor Definitions Page (Import Shared
Library Wizard) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10912
Configure Project Library Settings Page (Import Shared Library Wizard) . . . . 10913
Finish Page (Import Shared Library Wizard). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10914
Generation Summary Page (Import Shared Library Wizard) . . . . . . . . . . . . . . . 10915
Select Error Handling Mode Page (Import Shared Library Wizard) . . . . . . . . . . 10915
Select Functions to Convert Page (Import Shared Library Wizard) . . . . . . . . . . 10916
Select Shared Library and Header File Page (Import Shared Library Wizard) . . . . . .
10917
Specify Create or Update Mode Page (Import Shared Library Wizard) . . . . . . . 10917
Configure VIs and Controls Page (Import Shared Library Wizard). . . . . . . . . . . 10918
Import Web Service Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10925
Insert Subpalette Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10929
Installer Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10930
Additional Installers Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . 10932
Advanced Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . 10934
Destinations Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 10937
Dialog Information Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . 10939
Hardware Configuration Page (Installer Properties Dialog Box) . . . . . . . . . . . . 10941
Product Information Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . 10943

© National Instruments 301


LabVIEW Programming Reference Manual

Registry Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . 10944


Shortcuts Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . 10945
Source File Settings Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . 10947
Source Files Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 10949
Version Information Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . 10951
Web Services Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . 10953
Windows Security Page (Installer Properties Dialog Box) . . . . . . . . . . . . . . . . . . 10953
Instrument Driver VI Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10954
Invalid Filenames Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10958
Investigate Internal Error Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10958
Investigate Previous Internal Error or Warning Window . . . . . . . . . . . . . . . . . . . . . . . . 10959
LabVIEW Class Hierarchy Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10960
LLB Manager Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10961
Load and Save Warning List Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10963
Load Warning Summary Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10964
Mark Project Items to Separate Compiled Code Dialog Box . . . . . . . . . . . . . . . . . . . . . 10965
Mass Compile Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10966
Menu Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10968
Menu Editor Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10971
Merge LLBs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10972
Merge LLBs Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10973
Merge Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10974
Merge VIs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10975
Missing File Information Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10976
Multiple Variable Editor Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10977
My Computer Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10979
General Page (My Computer Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . 10979
Navigation Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10980
New Class/Interface Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10980
New Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10981
New Directory or LLB Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10984
New LLB Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10984
New Override Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10985
NI ACL Configuration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10985
NI Instrument Driver Finder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10986
NI Security Change Password Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10988

302 ni.com
LabVIEW Programming Reference Manual

NI Security Login Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10989


Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10990
Block Diagram Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10991
Controls/Functions Palettes Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . 10999
Environment Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11001
Front Panel Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11010
Menu Shortcuts Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11014
Paths Page (Options Dialog Box). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11016
Printing Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11019
Revision History Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11022
Search Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11024
Security Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11025
Shared Variable Engine Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 11027
Source Control Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11028
VI Server Page (Options Dialog Box). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11032
Web Server Page (Options Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11037
Organize Favorites Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11043
Override terminal defaults Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11043
Package Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11045
Advanced Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . 11046
Dependencies Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 11048
Destinations Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 11051
Feed Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11051
Information Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 11053
Package Installer Page (Package Properties Dialog Box). . . . . . . . . . . . . . . . . . . 11054
Package Page (Package Properties Dialog Box). . . . . . . . . . . . . . . . . . . . . . . . . . . 11054
Shortcuts Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . 11056
Source Files Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 11058
Version Information Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . 11058
Web Services Page (Package Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . 11060
Packed Library Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11060
Additional Exclusions Page (Packed Library Properties Dialog Box) . . . . . . . . 11061
Advanced Page (Packed Library Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11063
Connector Pane State Page (Packed Library Properties Dialog Box) . . . . . . . . 11064
Destinations Page (Packed Library Properties Dialog Box) . . . . . . . . . . . . . . . . . 11065
Information Page (Packed Library Properties Dialog Box) . . . . . . . . . . . . . . . . . 11067

© National Instruments 303


LabVIEW Programming Reference Manual

Pre/Post Build Actions Page (Packed Library Properties Dialog Box) . . . . . . . . 11068
Preview Page (Packed Library Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 11070
Source Files Page (Packed Library Properties Dialog Box) . . . . . . . . . . . . . . . . . 11070
Source File Settings Page (Packed Library Properties Dialog Box) . . . . . . . . . . 11072
Version Information Page (Packed Library Properties Dialog Box) . . . . . . . . . . 11075
Page Setup Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11077
Palette Documentation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11078
Perforce Changelist Description Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11079
Perforce Configuration Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11080
Perforce File Information Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11081
Perforce Project Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11082
Perforce Revision History Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11084
Perforce Submit Form Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11085
Polymorphic VI Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11086
Prepare Example VIs for NI Example Finder Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . 11088
Build Data File Page (Prepare Example VIs for NI Example Finder Dialog Box). . . . . .
11091
Preview Palette Changes Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11092
Print Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11093
Print Preview Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11103
Print Settings Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11104
Printer Setup Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11104
Probe Watch Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11105
Edit Items Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11106
Profile Performance and Memory Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11107
Project & System Comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11111
Project Dependency Conflicts Detected Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11113
Project Explorer Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11113
Project File Information Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11113
Project Library Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11114
Documentation Page (Project Library Properties Dialog Box) . . . . . . . . . . . . . . 11116
Friends Page (Project Library Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 11117
General Settings Page (Project Library Properties Dialog Box) . . . . . . . . . . . . . 11117
Item Settings Page (Project Library Properties Dialog Box) . . . . . . . . . . . . . . . . 11119
Protection Page (Class/Interface Properties Dialog Box) . . . . . . . . . . . . . . . . . . 11120
Project Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11121

304 ni.com
LabVIEW Programming Reference Manual

Project Page (Project Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11121


Conditional Disable Symbols Page (Project Properties Dialog Box) . . . . . . . . . 11122
Source Control Page (Project Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 11123
Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11124
Appearance Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11125
Background Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11145
Browse Options Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11146
Configuration Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11148
Cursors Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11149
Data Binding Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11151
Data Entry Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11152
Data Type Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11154
Display Format Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11157
Documentation Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11162
Edit Items Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11163
Fail-Safe Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11165
Key Navigation Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11165
Operation Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11169
Output Configuration Page (Properties Dialog Box). . . . . . . . . . . . . . . . . . . . . . . 11170
Plots Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11173
Scale Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11177
Scales Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11179
Scan Engine Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11182
Security Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11185
Size Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11186
Text Labels Page (Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11187
Quick Drop Configuration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11189
Quick Drop Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11192
Rearrange Cases Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11193
Rearrange Pages Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11194
Remote Panel Connection Manager Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11194
Remote Windows Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11195
Rename Express VI Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11196
Reset Revision History Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11197
Resize Objects Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11197
Resolve Load Conflict Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11198

© National Instruments 305


LabVIEW Programming Reference Manual

Resolve Project Conflicts Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11199


Considerations for Using the Resolve Project Conflicts Dialog Box . . . . . . . . . 11201
Review and Update from Type Def. Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11202
Save As Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11203
Save As Dialog Box (For Project Libraries) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11206
Save As Dialog Box (For Projects) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11207
Save Changes Before Closing? Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11208
Save Changes? (Close All) Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11209
Save for Previous Version Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11210
Save for Previous Warning Summary Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11210
Save Original Files Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11211
Search Palettes Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11211
Search Results Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11212
Select .NET Constructor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11214
Select .NET Control Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11215
Select a Bookmark Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11216
Select a VI Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11217
Select Ability Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11218
Select ActiveX Object Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11218
Select Assemblies Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11219
Select Contents To Copy Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11220
Select Error Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11220
Select Files to Recover Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11222
Select LLBs to Merge Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11223
Select Method Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11224
Select Object From Assembly Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11225
Select Object From Type Library Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11226
Select Palette from Project Library File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11227
Select Project File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11228
Select Property Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11229
Select Shared Variable Location Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11230
Select Source Control Project Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11230
Select Source Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11231
Select Source Item Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11232
Select Target File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11233
Select Type Libraries Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11233

306 ni.com
LabVIEW Programming Reference Manual

Select User or Client Workspace Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11234


Select VI By Name Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11235
Select VIs to Merge Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11236
Select VIs To Search Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11237
Set Time and Date Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11238
Shared Library Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11239
Additional Exclusions Page (Shared Library Properties Dialog Box). . . . . . . . . 11240
Advanced Page (Shared Library Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11243
Destinations Page (Shared Library Properties Dialog Box) . . . . . . . . . . . . . . . . . 11248
Information Page (Shared Library Properties Dialog Box) . . . . . . . . . . . . . . . . . 11250
Pre/Post Build Actions Page (Shared Library Properties Dialog Box) . . . . . . . . 11251
Preview Page (Shared Library Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 11253
Run-Time Languages Page (Shared Library Properties Dialog Box) . . . . . . . . . 11254
Source Files Page (Shared Library Properties Dialog Box) . . . . . . . . . . . . . . . . . 11255
Source File Settings Page (Shared Library Properties Dialog Box) . . . . . . . . . . 11256
Version Information Page (Shared Library Properties Dialog Box) . . . . . . . . . . 11260
Windows Security Page (Shared Library Properties Dialog Box) . . . . . . . . . . . . 11262
Shared Variable Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11263
Description Page (Shared Variable Properties Dialog Box) . . . . . . . . . . . . . . . . . 11264
Network Page (Shared Variable Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11265
Scaling Page (Shared Variable Properties Dialog Box). . . . . . . . . . . . . . . . . . . . . 11266
Variable Page (Shared Variable Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . 11268
Shortcut Menu Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11271
Show Buffer Allocations Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11273
Show Hidden Controls and Indicators Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11275
Source Control Operations Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11275
Source Distribution Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11277
Information Page (Source Distribution Properties Dialog Box) . . . . . . . . . . . . . 11278
Additional Exclusions Page (Source Distribution Properties Dialog Box) . . . . 11279
Advanced Page (Source Distribution Properties Dialog Box) . . . . . . . . . . . . . . . 11285
Destinations Page (Source Distribution Properties Dialog Box) . . . . . . . . . . . . 11286
Pre/Post Build Actions Page (Source Distribution Properties Dialog Box) . . . 11288
Preview Page (Source Distribution Properties Dialog Box) . . . . . . . . . . . . . . . . . 11289
Source File Settings Page (Source Distribution Properties Dialog Box) . . . . . . 11290
Source Files Page (Source Distribution Properties Dialog Box) . . . . . . . . . . . . . 11294
Version Information Page (Source Distribution Dialog Box) . . . . . . . . . . . . . . . . 11295

© National Instruments 307


LabVIEW Programming Reference Manual

SubVI Node Setup Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11296


Target Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11298
Host Environment Page (Target Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11298
General Page (Target Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11299
Miscellaneous Page (Target Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 11300
User Access Page (Target Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . 11301
TDMS File Viewer Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11302
Text Search Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11303
Third Party Add-ons Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11305
Third Party Add-on Activation Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11306
Automatically Activating Multiple Third-Party Add-ons . . . . . . . . . . . . . . . . . . . 11306
Automatically Activating One Third-Party Add-on . . . . . . . . . . . . . . . . . . . . . . . . 11307
Automatically Deactivating Third-Party Add-Ons . . . . . . . . . . . . . . . . . . . . . . . . . 11308
Manually Activating One Third-Party Add-on through the Telephone . . . . . . . 11309
Manually Activating One Third-Party Add-on through a Web Browser . . . . . . 11311
Manually Deactivating Third Party Add-ons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11312
Timeout for Wait On Asynchronous Call Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . 11313
Unable to Add Items Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11314
Undo File Rename? Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11314
Unsaved Files Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11315
User Colors Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11315
User Login Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11316
Validation Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11317
VI Analyzer - Select VIs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11317
VI Analyzer - Select Task Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11318
VI Analyzer - Select Tests Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11319
VI Analyzer - Exclude Tests from VIs Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . 11321
Export VI Analyzer Results Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11321
VI Analyzer Results Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11323
VI Analyzer Test Creator Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11325
VI Call Configuration Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11326
VI Hierarchy Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11328
VI Metrics Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11330
VI Properties Dialog Box (Application Builder) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11332
VI Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11336
Documentation Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . 11337

308 ni.com
LabVIEW Programming Reference Manual

Editor Options Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . 11339


Execution Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11340
General Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11344
Memory Usage Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . 11345
Print Options Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11347
Protection Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11349
Revision History Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . 11350
Window Appearance Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 11351
Window Run-Time Position Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . 11353
Window Size Page (VI Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11355
Web Publishing Tool Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11356
Web Service Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11359
HTTP Method VI Settings Page (Web Service Properties Dialog Box) . . . . . . . . 11359
Service Settings Page (Web Service Properties Dialog Box) . . . . . . . . . . . . . . . . 11362
Site Map Page (Web Service Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 11365
NI Web Server Privileges Page (Web Service Properties Dialog Box) . . . . . . . . 11365
Web Service Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11366
Additional Exclusions Page (Web Service Properties Dialog Box) . . . . . . . . . . . 11367
Advanced Page (Web Service Properties Dialog Box). . . . . . . . . . . . . . . . . . . . . . 11369
Destinations Page (Web Service Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11370
Information Page (Web Service Properties Dialog Box). . . . . . . . . . . . . . . . . . . . 11372
Pre/Post Build Actions Page (Web Service Properties Dialog Box) . . . . . . . . . . 11373
Preview Page (Web Service Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . 11375
Service Settings Page (Web Service Properties Dialog Box) . . . . . . . . . . . . . . . . 11376
Source Files Page (Web Service Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11377
Source File Settings Page (Web Service Properties Dialog Box) . . . . . . . . . . . . 11379
URL Mappings Page (Web Service Properties Dialog Box) . . . . . . . . . . . . . . . . . 11383
Why is this item in Dependencies? Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11385
XControl Properties Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11386
Documentation Page (XControl Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11386
Friends Page (XControl Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . 11387
General Settings Page (XControl Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11388
Item Settings Page (XControl Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . 11389
Protection Page (XControl Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . 11391
Zip File Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11392
Preview Page (Zip File Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11393

© National Instruments 309


LabVIEW Programming Reference Manual

Source Files Page (Zip File Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . . . . 11394


Zip File Structure Page (Zip File Properties Dialog Box) . . . . . . . . . . . . . . . . . . . 11395
Zip Information Page (Zip File Properties Dialog Box) . . . . . . . . . . . . . . . . . . . . . 11397
Error Codes and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11398
Block Diagram Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11398
Array and Cluster Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11398
Cluster is invalid or empty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11398
Cluster items are not named . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11399
Constant has undefined type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11400
Data type overflows the 16-bit integer array format . . . . . . . . . . . . . . . . . 11401
Formula Node and Expression Node Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11401
Array indexing expected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11401
Array operation not allowed here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11401
Array type required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11402
Assignment not allowed in Expression Node . . . . . . . . . . . . . . . . . . . . . . . . 11402
Case select value not unique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11402
Decrement operator not allowed in Expression Node . . . . . . . . . . . . . . . . 11402
Error in add expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11402
Error in and expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11402
Error in bit-and expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11402
Error in bit-or expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11402
Error in comparison expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11402
Error in equality expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in exclusive-or expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in exponent expression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in multiply expression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in or expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in shift expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Error in unary expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11403
Identifier expected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11404
Illegal break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11404
Illegal continue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11404
Increment operator not allowed in Expression Node . . . . . . . . . . . . . . . . 11404
Index list expected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11404

310 ni.com
LabVIEW Programming Reference Manual

Input is referenced by different names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11404


Integer constant required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11404
Integer type required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11404
Keyword while expected. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Missing colon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Missing left bracket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Missing left parenthesis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Missing right bracket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Missing right parenthesis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Missing semicolon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Only single expression allowed in Expression Node . . . . . . . . . . . . . . . . . 11405
Operator expected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11405
Semicolon not allowed in Expression Node . . . . . . . . . . . . . . . . . . . . . . . . . 11406
Structured statements are not allowed in Expression Node . . . . . . . . . . 11406
Too few arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11406
Too many arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11406
Type declarations not allowed in Expression Node . . . . . . . . . . . . . . . . . . 11406
Undefined function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11406
Undefined variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11406
Variable already defined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11406
Variable expected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11407
Function Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11407
Function conflict. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11407
Function is no longer supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11408
Function not found in library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11408
Function not supported by this version . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11409
No function specified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11409
LabVIEW Class Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11409
A class input to this tunnel or shift register does not originate at the Data
Value Reference Read Element border node . . . . . . . . . . . . . . . . . . . . . . . . 11409
Accessor VIs have different data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11410
Cannot have dynamic outputs without a dynamic input . . . . . . . . . . . . . 11410
Cannot use Call Parent Method node outside of a LabVIEW class . . . . . . 11411
Child class overrides a property accessor VI in a bad location within the
class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11411
Class cannot be bundled or unbundled because the class private data is

© National Instruments 311


LabVIEW Programming Reference Manual

empty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11412
Class input terminal is not marked as required. . . . . . . . . . . . . . . . . . . . . . 11412
Class or error data is assigned to the wrong side of the connector pane . . . . .
11412
Class output terminal does not return the input class . . . . . . . . . . . . . . . 11413
Class type of input terminal does not match class type of output terminal . . .
11413
Constant value includes broken or missing LabVIEW class . . . . . . . . . . . 11413
Dynamic front panel terminal cannot be placed inside a structure . . . . 11413
Illegal Property Node recursion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11414
Incompatible property definition override. . . . . . . . . . . . . . . . . . . . . . . . . . 11414
Invalid accessor VI connector pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11415
Neither bundle nor unbundle of this LabVIEW class is allowed on this VI . . . . .
11415
One of the class inputs to this Max and Min function does not originate at the
Data Value Reference Read Element border node . . . . . . . . . . . . . . . . . . . 11415
One of the class inputs to this Select function does not originate at the Data
Value Reference Read Element border node . . . . . . . . . . . . . . . . . . . . . . . . 11416
One of the class inputs to this Select function does not originate at the
dynamic control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11417
One of the class terminals is static and the other class terminal is dynamic . .
11418
One of the inputs to this Max & Min function does not originate at the
dynamic input front panel terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11419
One or more of the inputs to this tunnel or shift register does not originate at
the dynamic input front panel terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11419
One or more of the set of VIs that this dynamic dispatch subVI or property
item may call are broken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11420
Parent class does not define this method. . . . . . . . . . . . . . . . . . . . . . . . . . . 11421
Property is not readable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11422
Property is not writable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11422
Reentrant VI with dynamic input terminal must use 'Shared clone reentrant
execution' option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11422
Reference creation and deletion for this class is restricted . . . . . . . . . . . 11422
Refers to a broken LabVIEW class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11422
Refers to a dynamic member VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11423

312 ni.com
LabVIEW Programming Reference Manual

Refers to a missing LabVIEW class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11423


Run-time type not propagated from dynamic input to dynamic output . . . . . .
11424
The class object inside a reference cannot be exchanged with another class
object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11425
The overriding accessor VI has a different filename than the accessor VI in
the parent class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11426
The property definition adds readability or writability to an overridden
property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11427
The property definition folder contains a member that is not a VI . . . . . 11427
The property definition folder does not have a valid accessor VI . . . . . . 11427
The property definition folder has a colon in its name . . . . . . . . . . . . . . . 11427
The property definition folder has a duplicate long name . . . . . . . . . . . . 11427
The property definition folder has more than one read VI . . . . . . . . . . . . 11427
The property definition folder has more than one write VI . . . . . . . . . . . 11428
The wired class does not support a method of this VI's name . . . . . . . . . 11428
This dynamic dispatch VI does not unconditionally invoke the Call Parent
Method node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11428
This function does not support LabVIEW classes . . . . . . . . . . . . . . . . . . . . 11430
This VI cannot access the class constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11430
This VI cannot access the referenced item . . . . . . . . . . . . . . . . . . . . . . . . . . 11430
This VI cannot access the referenced item in community scope . . . . . . . 11430
This VI cannot access the referenced item in private scope . . . . . . . . . . . 11431
This VI cannot access the referenced item in protected scope . . . . . . . . 11431
This VI cannot connect to the referenced item in a locked library . . . . . 11431
This VI is not an accessor VI, but it overrides one . . . . . . . . . . . . . . . . . . . . 11431
To More Specific Class must cast to the original data type of the Data Value
Reference Read Element border node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11432
To More Specific Class must cast to the original data type of the dynamic
input front panel terminal or an ancestor type . . . . . . . . . . . . . . . . . . . . . . 11432
Unexpected type on accessor VI class or error terminal . . . . . . . . . . . . . . 11433
Wrong connector pane pattern for accessor VI . . . . . . . . . . . . . . . . . . . . . . 11433
You cannot type cast between different data value reference types . . . 11433
Miscellaneous Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11434
Add-on has a license that is unsupported on this platform . . . . . . . . . . . 11434
Add-on is expired or invalidly licensed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11434

© National Instruments 313


LabVIEW Programming Reference Manual

Bad unit syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11435


Channel cannot be used as a constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11435
Constant refers to a broken type definition . . . . . . . . . . . . . . . . . . . . . . . . . 11435
Enumeration conflict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11435
External component or driver missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11436
External data value reference on the block diagram contains unsupported
data type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11436
Global VI is missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11436
Hidden front panel control has undefined type . . . . . . . . . . . . . . . . . . . . . 11437
LabVIEW needs more memory to compile VI . . . . . . . . . . . . . . . . . . . . . . . . 11437
Multiline available only in regular expression mode . . . . . . . . . . . . . . . . . 11438
No item with this name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11438
Target type is not a more generic type than reference type . . . . . . . . . . . 11438
The channel control cannot be inside a structure . . . . . . . . . . . . . . . . . . . 11439
The data types for the event registration refnums do not match . . . . . . 11439
Unable to display block diagram or perform Save for Previous with add-on
VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11439
VI edited in another application instance . . . . . . . . . . . . . . . . . . . . . . . . . . . 11440
VI failed to compile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11440
Waveform is invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11440
Wired refnums are of different types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11440
Node Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11441
Bad linkage to method information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11442
Invalid constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11442
Invalid dotted method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11442
Invalid dotted property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11443
Invalid method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11443
Invalid property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11444
Invalid refnum class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11444
Invalid shared variable configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11444
Library not found or failed to load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11445
Library that defines the XNode cannot be found . . . . . . . . . . . . . . . . . . . . 11445
Library that defines the XNode is broken . . . . . . . . . . . . . . . . . . . . . . . . . . . 11445
Library version is incompatible with XNode version . . . . . . . . . . . . . . . . . 11445
No event selected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11445
No library specified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11446

314 ni.com
LabVIEW Programming Reference Manual

Node contains terminals that are wired but not valid . . . . . . . . . . . . . . . . 11446
Property Node cannot write to property that is read-only for strict type
definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11446
Read only: cannot write to this shared variable . . . . . . . . . . . . . . . . . . . . . 11446
Shared Variable is broken. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11447
Shared Variable local access mode not supported for this variable . . . . 11447
Shared variable timeout mode not supported for this variable type . . . 11447
State of the XNode is incompatible with the library that defines the XNode . .
11447
The reference input for all styles of Call By Reference nodes must be a strict
VI reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11448
This variable can only access a typedef in public scope . . . . . . . . . . . . . . 11448
Unexpected XNode error occurred . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11448
Write only: cannot read from this shared variable . . . . . . . . . . . . . . . . . . . 11448
XNode is not executable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11449
Project Library Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11449
Library that contains the VI or item is not properly licensed . . . . . . . . . . 11449
Owning library has blocked execution of the VI . . . . . . . . . . . . . . . . . . . . . 11449
The owning library of this VI is missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11449
This VI's owning library is missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11450
This VI claims to be part of a library, but that library does not claim to own
this VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11450
VI's record of owning library's password does not match library's actual
password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11450
The VI cannot access the referenced function . . . . . . . . . . . . . . . . . . . . . . . 11450
Script Node Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11451
One or more inputs (or outputs) share the same name . . . . . . . . . . . . . . 11451
Script node terminal has no name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11451
Script node terminal type conflict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11452
Script node terminal type not supported by server . . . . . . . . . . . . . . . . . . 11453
Script support DLL not found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11453
Script text is being edited by server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11453
String Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11454
Format specifier type mismatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11454
Too few format specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11454
Too many format specifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11455

© National Instruments 315


LabVIEW Programming Reference Manual

Unknown format specifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11455


Structure Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11456
Parallel For Loop Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11456
C is not wired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11456
Parallel For Loop cannot contain a Boolean control with latch option . .
11456
Parallel For Loop cannot contain a conditional terminal . . . . . . . . 11457
Parallel For Loop cannot contain a dependence between loop
iterations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11457
Parallel For Loop cannot contain a Feedback Node . . . . . . . . . . . . . 11457
Parallel For Loop cannot contain a stacked shift register . . . . . . . . 11458
Parallel For Loop cannot contain an array dependence between loop
iterations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11458
Parallel For Loop cannot contain an uninitialized shift register. . . 11458
Case does not have selector value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11459
Conditional Disable node has invalid or empty condition(s) . . . . . . . . . . 11459
Conditional terminal is not wired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11460
Diagram/Conditional Disable Structure has no active diagram . . . . . . . 11460
Duplicate items selected in an Event Filter Node . . . . . . . . . . . . . . . . . . . . 11461
Duplicate parameter name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11461
Dynamic event configuration does not match dynamic event registration . . .
11462
Event specified by more than one event case . . . . . . . . . . . . . . . . . . . . . . . 11462
Events specified by event case are not compatible with each other . . . 11463
Event Structure: Event unavailable in standard VI . . . . . . . . . . . . . . . . . . . 11464
Feedback Node: data type is undefined . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11465
Invalid parameter name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11465
Missing assignment to tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11465
Multiple assignment to tunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11466
N is not wired, and there are no indexing inputs. . . . . . . . . . . . . . . . . . . . . 11467
No case for some selector values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11468
One or more event cases have no events defined . . . . . . . . . . . . . . . . . . . 11469
Reserved parameter name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11470
Selector values are not unique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11471
Selector values have wrong type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11471
Sequence local has sources on separate frames . . . . . . . . . . . . . . . . . . . . . 11472

316 ni.com
LabVIEW Programming Reference Manual

Shift register: data type is undefined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11472


Shift register: unwired from inside the loop . . . . . . . . . . . . . . . . . . . . . . . . . 11472
Timeout input wired but Timeout event not handled . . . . . . . . . . . . . . . . 11473
Tunnel has undefined type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11474
Unassigned sequence local(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11474
Unwired input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11474
Unwired selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11475
User event data type is unnamed or has elements with no names or
duplicate names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11475
You have initialized some shift register elements but not all of them . . 11476
Subroutine Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11476
Subroutine priority VI cannot call a non-subroutine priority subVI . . . . 11476
Subroutine priority VI cannot contain an asynchronous node . . . . . . . . 11477
SubVI Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11477
Bad linkage to subVI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11477
Part of a broken recursive cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11478
Polymorphic subVI is broken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11478
Polymorphic VI does not contain subVIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11478
Recursive reference in non-reentrant VI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11478
Recursive reference with no shared reentrancy . . . . . . . . . . . . . . . . . . . . . 11479
Recursive VI call could not determine inplaceness . . . . . . . . . . . . . . . . . . . 11479
Static VI Reference is not currently linked to a VI . . . . . . . . . . . . . . . . . . . . 11479
SubVI is already running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11480
SubVI is in interactive retrieval mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11480
SubVI is in panel order or cluster order mode . . . . . . . . . . . . . . . . . . . . . . . 11480
SubVI is missing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11480
SubVI is not executable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11482
VI has a bad connection to or cannot find a subVI or external routine . . 11482
Wiring Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11482
Array element conflict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11482
Class conflict . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11483
Contains unwired or bad terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11484
Flatten To JSON type is invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11485
More than one index input is wired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11485
Required input is not wired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11487
The channel control contains unwired terminals . . . . . . . . . . . . . . . . . . . . 11488

© National Instruments 317


LabVIEW Programming Reference Manual

The channel wire cannot pass through a structure . . . . . . . . . . . . . . . . . . 11488


The channel wire cannot pass through a subVI . . . . . . . . . . . . . . . . . . . . . . 11488
The channel wire endpoint contains unwired terminals. . . . . . . . . . . . . . 11489
The data type cannot be used with the Interface to Data format . . . . . . 11489
This channel wire cannot enter or leave a parallel For Loop . . . . . . . . . . 11489
This channel wire cannot fork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11490
This variable is not connected to anything. . . . . . . . . . . . . . . . . . . . . . . . . . 11490
This wire connects one or more data sinks but has no source . . . . . . . . . 11490
This wire connects more than one data source . . . . . . . . . . . . . . . . . . . . . . 11491
This wire is not connected to anything . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11491
Wire connected to an undirected tunnel. . . . . . . . . . . . . . . . . . . . . . . . . . . . 11492
Wire has loose ends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11492
Is a member of a cycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11493
You have attempted to connect a wire to a floating object. . . . . . . . . . . . 11493
You have connected a control to a control . . . . . . . . . . . . . . . . . . . . . . . . . . 11494
You have connected an indicator to an indicator . . . . . . . . . . . . . . . . . . . . 11494
You have connected numeric data types that have incompatible units . . . . . .
11495
Polymorphic terminal cannot accept this data type . . . . . . . . . . . . . . . . . 11496
Unflatten From JSON type is invalid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11497
You have connected a scalar type to an array of that type . . . . . . . . . . . . 11497
You have connected two arrays of different dimensions . . . . . . . . . . . . . 11497
You have connected two clusters with different contents . . . . . . . . . . . . 11498
You have connected two terminals of different types . . . . . . . . . . . . . . . . 11498
Block Diagram Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11499
LabVIEW Class Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11499
Class has editor changes not yet applied . . . . . . . . . . . . . . . . . . . . . . . . . . . 11499
Parent class of this LabVIEW class has a data type problem . . . . . . . . . . 11499
Default value includes broken or missing LabVIEW class . . . . . . . . . . . . . 11499
Dynamic terminals must be of same class as owner of VI . . . . . . . . . . . . . 11500
Private data control of this class must be a cluster . . . . . . . . . . . . . . . . . . 11501
Private data control of this class uses an illegal value for its default data . . . .
11502
Private data control of this LabVIEW class has an undefined type . . . . . 11503
Private data control of this class is not a valid data type. . . . . . . . . . . . . . 11504
Refers to a broken LabVIEW class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11504

318 ni.com
LabVIEW Programming Reference Manual

Refers to a missing LabVIEW class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11504


This VI cannot access the class control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11505
Miscellaneous Front Panel Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11505
Boolean latch action is incompatible with local variables . . . . . . . . . . . . 11505
Channel controls or indicators cannot be nested inside another control or
indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11506
Channel controls or indicators must be on the connector pane . . . . . . . 11506
Control contains no elements and is undefined . . . . . . . . . . . . . . . . . . . . . 11506
Control has bad unit syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11506
Control requires an external library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11507
Could not determine data types of all wires in this VI . . . . . . . . . . . . . . . . 11507
Empty custom control panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11507
Enumeration items must be unique. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11507
External data value reference on the front panel contains unsupported data
type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11507
Extra controls on custom control's front panel . . . . . . . . . . . . . . . . . . . . . . 11508
Radio button has enumeration conflict . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11508
The XControl used in this VI is broken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11509
Type does not coerce. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11509
Unresolved linkage to network-published variable . . . . . . . . . . . . . . . . . . 11510
XControl is disconnected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11510
XControl not supported for current target . . . . . . . . . . . . . . . . . . . . . . . . . . 11510
The VI cannot access the XControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11510
Type Definition Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11510
Cannot use an XControl in a private data control . . . . . . . . . . . . . . . . . . . . 11511
Control does not match its type definition . . . . . . . . . . . . . . . . . . . . . . . . . . 11511
Control is corrupt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11511
Front panel control contains a data type with a type definition . . . . . . . 11511
Invalid use of type definition in Control Editor . . . . . . . . . . . . . . . . . . . . . . 11511
LabVIEW cannot update from type definition without incorrectly preserving
default values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11512
Refers to a broken type definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11513
This type definition has unapplied changes . . . . . . . . . . . . . . . . . . . . . . . . 11513
Type definition inside that same type definition . . . . . . . . . . . . . . . . . . . . 11513
Type definition not found or contains errors . . . . . . . . . . . . . . . . . . . . . . . . 11513
Type definition cannot have array of arrays . . . . . . . . . . . . . . . . . . . . . . . . . 11513

© National Instruments 319


LabVIEW Programming Reference Manual

Typedef has unapplied changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11513


Typedef is broken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11514
Typedef mismatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11514
Project Library Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11514
This library claims to be owned by another library . . . . . . . . . . . . . . . . . . . . . . . 11514
A subVI which claims to be part of a dependent packed library is missing from that
packed library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11514
This library is invalidly licensed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11514
The owning library is broken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11515
LabVIEW Class Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11515
Ancestor classes are reserved for run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11515
At least one dynamic member VI of this LabVIEW class is broken . . . . . . 11515
The parent of this LabVIEW class is broken . . . . . . . . . . . . . . . . . . . . . . . . . 11515
The private data control for this class has unapplied changes . . . . . . . . 11515
The private data control of this LabVIEW class is broken . . . . . . . . . . . . . 11516
This LabVIEW class cannot find its parent class . . . . . . . . . . . . . . . . . . . . . 11516
This LabVIEW class definition is corrupt . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11516
This LabVIEW class is missing at least one member VI. . . . . . . . . . . . . . . . 11516
The parent of this LabVIEW class is private and is not accessible from this
class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11517
Target Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11517
VI must be reentrant to use a control of this type . . . . . . . . . . . . . . . . . . . . . . . . . 11517
Cannot mix static and dynamic data in a cluster . . . . . . . . . . . . . . . . . . . . . . . . . 11517
Constant of this type is not supported on this target . . . . . . . . . . . . . . . . . . . . . . 11518
VI must be reentrant if a control of this type is on the connector pane . . . . . . 11518
A control of this type must be on the connector pane . . . . . . . . . . . . . . . . . . . . . 11518
VI Error Messagess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11518
LabVIEW Class Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11518
Dynamic dispatch VIs cannot be in community scope. . . . . . . . . . . . . . . . 11518
Dynamic dispatch VIs cannot be in private scope . . . . . . . . . . . . . . . . . . . . 11519
Only VIs owned by a LabVIEW class may use dynamic terminals in the
connector pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11520
Property data terminal is assigned to the wrong side of the connector
pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11520
The parent of this LabVIEW class is in community scope and is not accessible
from this class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11520

320 ni.com
LabVIEW Programming Reference Manual

This class cannot inherit from the community scoped item in a locked
library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11521
This VI attempts to override a static VI in an ancestor class . . . . . . . . . . . 11521
Polymorphic VI Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11521
Dynamic dispatch VIs cannot be members of polymorphic VIs . . . . . . . . 11521
Invalid polymorphic subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11521
Polymorphic instances have different connector pane terminals. . . . . . 11522
Polymorphic instances have different terminal directions on connector
panes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11522
Polymorphic VIs cannot contain instances that also are polymorphic VIs . . . .
11522
This polymorphic VI has no subVIs or has subVIs with different connector
patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11522
Control VI has unapplied changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11522
This object is not allowed in a VI on which you enable inlining . . . . . . . . . . . . . 11522
This VI does not match other VIs in the method; connector pane patterns are
different . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11523
This VI does not match other VIs in the method; connector pane terminal(s) are
different . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11523
This VI does not match other VIs in the method; execution priorities are
different . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11523
This VI does not match other VIs in the method; one is reentrant, one is not . . . . . .
11523
This VI does not match other VIs in the method; preferred execution systems are
different . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11524
This VI does not match other VIs in the method; the scope is different . . . . . . 11524
This VI is configured with inlining and automatic error handling enabled . . . 11524
This VI is configured with inlining and debugging enabled . . . . . . . . . . . . . . . . 11524
This recursive VI is configured with inlining enabled . . . . . . . . . . . . . . . . . . . . . . 11524
VI containing Shared Variable node needs to be loaded in a project . . . . . . . . 11525
Ranges of LabVIEW Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11525
3D Picture Control Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11525
Deployment Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11527
EPICS Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11528
FTP Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11530
General LabVIEW Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11531

© National Instruments 321


LabVIEW Programming Reference Manual

GPIB Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11555


Input Device Control VI Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11557
Instrument Driver Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11558
LabVIEW Object-Oriented Programming Error Codes . . . . . . . . . . . . . . . . . . . . . 11559
Mathematics Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11561
Mathscript Error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11564
Modbus Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11565
Network Streams Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11566
Networking Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11570
OPC UA Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11575
Point By Point Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11579
Regular Expression Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11580
Report Generation Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11582
Run-Time Menu Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11583
Script Node Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11584
Security Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11584
Serial Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11585
Shared Variable Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11585
Signal Processing Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11589
SMTP Email Reply Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11596
Source Control Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11597
Storage/DataPlugin and TDM Streaming Error Codes . . . . . . . . . . . . . . . . . . . . . 11601
Timed Loop Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11608
VISA Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11610
Waveform Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11614
Windows Connectivity Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11616
Web Services Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11617
Windows Registry Access Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11621
XML Parser Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11623
Windows Embedded Standard Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11629

322 ni.com
LabVIEW Programming Reference Manual

LabVIEW Programming Reference Manual


The LabVIEW Programming Reference Manual includes detailed descriptions of
functions, methods, and properties as well as error code descriptions and dialog box
references.

Other Resources
Changes in LabVIEW
Learn about updates – including new features and behavior changes — introduced in
each version of LabVIEW. This collection of "what's new" information documents the
evolution of LabVIEW.

Upgrading Your Version of LabVIEW


Use this rigorous upgrade process to detect and correct upgrade difficulties as
efficiently as possible.

LabVIEW Release Notes


Visit this site for links to known issues, bugs fixed since the last release, and other
notes for any LabVIEW release.

NI License Manager Documentation


Find documentation about activating, deactivating, and transferring software products
using license activation codes or license files. For license administrators, this manual
includes information for automating product activation and adding volume license
servers.

Note This documentation is partially processed by a machine translation


tool to provide a general idea of the content in multiple languages. There
may be small errors or inaccuracies and National Instruments recommends
that customers switch to English content to view the official reference
documentation.

© 2005–2023 National Instruments Corporation. All rights reserved. Refer to the


<National Instruments>\_Legal Information directory for information

© National Instruments 323


LabVIEW Programming Reference Manual

about NI copyright, patents, trademarks, warranties, product warnings, and export


compliance.

324 ni.com
Functions

Functions
The VIs and functions located on the Functions palette depend on the visible palette
categories. Click the Customize button on the Functions palette and select Change
Visible Palettes from the shortcut menu to display all palette categories on the
Functions palette. You also can click the Change Visible Palettes link at the bottom of a
pinned Functions palette to display the palette categories.

The VIs and functions on the Functions palette can return general or specific LabVIEW
error codes.

Palette Object Description

Programming Use the Programming VIs and functions as the basic building blocks for a VI.

Use the Measurement I/O VIs and functions to interface with NI-DAQmx and other
data acquisition devices. This palette displays the VIs and functions for the
Measurement hardware drivers you install.
I/O
If driver VIs you expected to find on this palette are missing, you must install
support for the driver in the current version of LabVIEW.

Use the Instrument I/O VIs and functions to interface with GPIB, serial, modular,
PXI, and other types of instruments. Use the NI Instrument Driver Finder to search
for and install instrument drivers. If an instrument driver is not available in the NI
Instrument Driver Finder, you can use the Create New Instrument Driver Project
Instrument I/O
wizard to create a new instrument driver.

If driver VIs you expected to find on this palette are missing, you must install
support for the driver in the current version of LabVIEW.

Refer to the NI Vision, NI Vision Acquisition Software, NI-Motion, and NI


Vision and
SoftMotion help files, which you can access from the Help menu, for more
Motion
information about those VIs. If NI Vision Acquisition Software, NI-Motion, and NI

© National Instruments 325


Functions

Palette Object Description

SoftMotion are not installed, you cannot access the help files. Install these
additional packages from the media included with LabVIEW.

Use the Mathematics VIs to perform many different kinds of mathematical


Mathematics analysis. You also can interface real-world measurements to the mathematical
algorithms in order to obtain practical solutions.

Signal Use the Signal Processing VIs to perform signal generation, digital filtering, data
Processing windowing, and spectrum analysis.

Data Use the Data Communication VIs and functions to exchange data between
Communication applications.

Use the Connectivity VIs and functions to work with .NET objects, ActiveX-enabled
applications, input devices, register addresses, source control, Web services,
Connectivity
Windows registry keys, and other software, including National Instruments
products you purchase.

Control & Use the Control and Simulation VIs and Functions to design, analyze, simulate,
Simulation and deploy dynamic system models.

Express Use the Express VIs and functions to build common measurement tasks.

Use the Addons category to access LabVIEW add-ons and to locate palettes of
Addons
some modules or toolkits that you have installed in LabVIEW.

Use the Favorites category to group together items on the Functions palette that
Favorites you access frequently. You can add items to the Favorites category using the
Category (Standard), Category (Icons and Text), Icons, and Icons and Text

326 ni.com
Functions

Palette Object Description

formats. You then can organize your Favorites using the Organize Favorites dialog
box.

Use the User Libraries palette to add VIs to the Functions palette. By default, the
User Libraries
User Libraries palette does not contain any objects.

Programming
Use the Programming VIs and functions as the basic building blocks for a VI.

Palette Object Description

Structures Use the structures to build VIs.

Array Use the Array functions to create and manipulate arrays.

Use the Cluster, Class & Variant VIs and functions to create and manipulate
Cluster, Class, & clusters and LabVIEW classes, convert LabVIEW data to a format you can
Variant manipulate independent of data type, add attributes to the data, and convert
variant data to LabVIEW data.

Use the Numeric VIs and functions to create and perform arithmetic and complex
mathematical operations on numbers and to convert numbers from one data
Numeric
type to another. Use the VIs and functions on the Elementary and Special
Functions and VIs palette to perform trigonometric and logarithmic functions.

Use the Boolean functions to perform logical operations on single Boolean values
Boolean
or arrays of Boolean values.

© National Instruments 327


Functions

Palette Object Description

Use the String functions to concatenate two or more strings, extract a subset of
String strings from a string, convert data into strings, and format a string for use in a
word processing or spreadsheet application.

Use the Comparison functions to compare Boolean values, strings, numeric


Comparison
values, arrays, and clusters.

Use the Waveform VIs and functions to build waveforms that include the
Waveform waveform values, channel information, and timing information, and to set and
retrieve waveform attributes and components.

Collection Use the Collection VIs and functions to manipulate collection data.

Use the File I/O VIs and functions to open and close files, read from and write to
File I/O files, create directories and files you specify in the path control, retrieve directory
information, and write strings, numbers, arrays, and clusters to files.

Use the Timing VIs and Functions to manipulate the speed at which an operation
Timing
executes and to retrieve time and date information from the computer clock.

Dialog & User Use the Dialog & User Interface VIs and functions to create dialog boxes to prompt
Interface users with instructions.

Use the Synchronization VIs and functions to synchronize tasks executing in


Synchronization
parallel and to pass data between parallel tasks.

Graphics & Use the Graphics & Sound VIs to create custom displays, import and export data
Sound from graphics files, and play sounds.

328 ni.com
Functions

Palette Object Description

Use the Application Control VIs and functions to programmatically control VIs
Application
and LabVIEW applications on the local computer or across a network. You can use
Control
these VIs and functions to configure multiple VIs at the same time.

Use the Report Generation VIs to create and manipulate reports of LabVIEW
Report
applications. You also can use the VIs on this palette to insert text, tables, and
Generation
graphs into bookmark locations.

Structures
Use the structures to build VIs.

Palette
Description
Object
Executes its subdiagram n times, where n is the value wired to the count (N)
For Loop terminal. The iteration (i) terminal provides the current loop iteration count, which
ranges from 0 to n-1.
Repeats the code within its subdiagram until a specific condition occurs. A While
While Loop
Loop always executes at least one time.

Use the Timed Structures and VIs to control the rate and priority at which a timed
Timed
structure executes its subdiagram, synchronize the start time of timed structures,
Structures
create timing sources, and establish a hierarchy of timing sources.

Contains one or more subdiagrams, or cases, exactly one of which executes when
Case
the structure executes. The value wired to the case selector determines which case
Structure
to execute.
Waits until an event occurs, then executes the appropriate case to handle that
Event
event. The Event structure has one or more subdiagrams, or event cases, exactly
Structure
one of which executes when the structure executes to handle an event. This

© National Instruments 329


Functions

Palette
Description
Object
structure can time out while waiting for notification of an event. Wire a value to the
Timeout terminal at the top left of the Event structure to specify the number of
milliseconds the Event structure waits for an event. The default is -1, which
indicates never to time out.
Controls how the LabVIEW compiler performs certain operations and, in some
cases, increases memory and VI efficiency. Use the In Place Element structure when
you operate on a data element within an array, cluster, variant, or waveform
In Place
without requiring the LabVIEW compiler to copy data values and maintain those
Element
values in memory. You also can use this structure to operate on any data type that
Structure
you want to maintain within the same data space in memory. Right-click the border
of the structure and select the border node that matches the operation you want to
perform.
Consists of one or more subdiagrams, or frames, that execute sequentially. Use the
Flat Sequence structure to ensure that a subdiagram executes before or after
Flat another subdiagram. Data flow for the Flat Sequence structure differs from data
Sequence flow for other structures. Frames in a Flat Sequence structure execute from left to
Structure right and when all data values wired to a frame are available. The data leaves each
frame as the frame finishes executing. This means the input of one frame can
depend on the output of another frame.
Evaluates mathematical formulas and expressions similar to C on the block
diagram. The following built-in functions are allowed in formulas: abs, acos, acosh,
Formula asin, asinh, atan, atan2, atanh, ceil, cos, cosh, cot, csc, exp, expm1, floor, getexp,
Node getman, int, intrz, ln, lnp1, log, log2, max, min, mod, pow, rand, rem, sec, sign, sin,
sinc, sinh, sizeOfDim, sqrt, tan, tanh. There are some differences between the
parser in the Mathematics VIs and the Formula Node.
Diagram Has one or more subdiagrams, or cases, of which only the Enabled subdiagram
Disable executes. Use the Diagram Disable structure to disable a section of the block
Structure diagram.
Has one or more subdiagrams, exactly one of which LabVIEW uses for the duration
of execution, depending on the configuration of the conditions of the subdiagram.
Conditional Use this structure when you want to disable specific sections of code on the block
Disable diagram based on some user-defined condition. Right-click the structure border to
Structure add or delete a subdiagram. When you add a subdiagram or right-click the structure
border and select Edit Condition For This Subdiagram from the shortcut menu,
you can configure conditions in the Configure Condition dialog box.
Type Has one or more subdiagrams, exactly one of which LabVIEW compiles and
Specialization executes, depending on the order and the compilation result of the subdiagram.

330 ni.com
Functions

Palette
Description
Object
LabVIEW declines subdiagrams in order if they have syntax errors. LabVIEW accepts
the first subdiagram that does not have syntax errors and ignores the remaining
subdiagrams. If all subdiagrams have syntax errors, this structure accepts the last
subdiagram. Syntax errors are errors within the structure, such as broken wires, not
Structure errors caused by subVIs or other dependencies. Use this structure to customize
sections of code in a malleable VI (.vim) for specific data types. You also can use this
structure in conjunction with the Assert Type VIs and functions to force a malleable
VI to accept only a subset of the acceptable data types or to decline specific data
types.
Represents a shared variable on the block diagram. To bind a Shared Variable node
to a shared variable from the active project, add a Shared Variable node to the
Shared block diagram and double-click or right-click the node and select Select
Variable Variable>>Browse from the shortcut menu to display the Browse for Variable dialog
box. You also can drag a shared variable from the Project Explorer window onto the
block diagram of a VI in the same project to create a Shared Variable node.
Use local variables to read or write to one of the controls or indicators on the front
Local Variable
panel of a VI.
Global
Use global variables to access and pass data among several VIs.
Variable

Use the decorations located on the Decorations palette to group or separate objects
Decorations on a block diagram with boxes, lines, or arrows. These objects are for decoration
only and do not modify data.

Feedback
Stores data from one VI execution or loop iteration to the next.
Node

For Loop

Executes its subdiagram n times, where n is the value wired to the count (N) terminal.
The iteration (i) terminal provides the current loop iteration count, which ranges from
0 to n-1.

© National Instruments 331


Functions

Terminal Inputs
• —The count terminal specifies the number of times to execute the code inside
the For Loop. If you wire 0 or a negative number to the count terminal, the loop
does not execute.

This terminal is displayed by default.

• —(Optional) The parallel instances terminal specifies the number of loop


instances LabVIEW uses to run parallel loop iterations. If you leave the input of the
parallel instances terminal unwired, LabVIEW automatically detects the number of
logical processors in the machine and uses it as the default parallel instances
terminal value.

You can use the input of the parallel instances terminal and the Number of
generated parallel loop instances in the For Loop Iteration Parallelism dialog box
to improve For Loop performance by oversubscribing or undersubscribing.

To display this terminal, enable parallel For Loop iterations.

• —(Optional) The chunk size terminal specifies the custom iteration schedule
used to execute chunks of loop iterations in parallel when you enable parallel For
Loop iterations. You should specify a custom schedule only if the For Loop would
benefit from a schedule different from the default.

To display this terminal, programmatically configure the loop iteration schedule.

• —(Optional) The conditional terminal allows you to specify additional conditions


for stopping the For Loop. The For Loop normally stops after executing the number
of iterations you specify using the count terminal. However, you can use the
conditional terminal to stop the For Loop when other conditions occur, such as an
error.

By default, the conditional terminal is set to Stop if True. You can change the

332 ni.com
Functions

behavior of the conditional terminal to Continue if True.

To display this terminal, set the For Loop to stop when a condition occurs.

Terminal Outputs
• —(Optional) The count terminal indicates the number of times to execute the
code inside the For Loop.
• —(Optional) The iteration terminal indicates the number of completed iterations.
The first iteration is 0.

This terminal is displayed by default.

• —(Optional) Right-click the terminal and select P Terminal Output to specify the
output of the parallel instances terminal. The terminal provides the following
outputs:
• Number of Instances—Number of loop instances LabVIEW is running in parallel.
This number is the minimum of the value wired to the parallel instances
terminal and the Number of generated parallel loop instances in the For Loop
Iteration Parallelism dialog box.
• Current Instance ID—Numeric identifier between 0 and P–1 assigned to the
loop instance that is executing the current iteration.
• —(Optional) Indicates the size of the chunk containing the loop iteration that
LabVIEW is currently executing.

For Loop Tunnel Inputs

Loop tunnels allow you to pass data through the For Loop. You can change the tunnel
mode to handle data that passes through the For Loop in different ways, as listed in
the following table.

• —The tunnel passes data into and out of the For Loop without additional
manipulation.
• —Shift registers access data from the previous loop iteration and pass data to
the next loop iteration.
• —When you wire an array or a collection data type to the input tunnel of the For
Loop, the auto-index tunnels read and process one element in the array or
collection per loop iteration.

© National Instruments 333


Functions

For Loop Tunnel Outputs

You can configure the For Loop to return the last value of the last loop iteration, an
indexed array of every value generated by the loop, or a concatenated array of every
value generated by the loop by right-clicking the loop output tunnel and selecting
Tunnel Mode from the shortcut menu.

While Loop

Repeats the code within its subdiagram until a specific condition occurs. A While Loop
always executes at least one time.

Components of a While Loop

• —Subdiagram—Contains code that the While Loop executes once per iteration.
• —Iteration Terminal (i)—Provides the current loop iteration count. The loop
count always starts at zero for the first iteration. If the iteration count exceeds
2,147,483,647, or 231-1, the iteration terminal remains at 2,147,483,647 for all
further iterations. If you need to keep count of more than 2,147,483,647 iterations,
you can use shift registers with a greater integer range.
• —Conditional Terminal—Evaluates a Boolean input value to determine whether
to continue executing the While Loop. To specify whether the loop stops for a TRUE
or FALSE Boolean value, configure the continuation behavior of the loop. You also

334 ni.com
Functions

can determine when the loop stops by wiring an error cluster to the conditional
terminal.

Tip To create a While Loop that automatically wires a stop button to the
conditional terminal, add the While Loop from the Execution Control palette.

Configuring a While Loop

• Creating a basic While Loop


• Adjusting the timing of execution
• Automatically processing each element in an array
• Accumulating data in arrays leaving loops
• Passing values between iterations
• Monitoring the Boolean value of a terminal for each loop iteration
• Converting a While Loop to a For Loop or Timed Loop
• Conditionally writing values to output tunnels

Troubleshooting a While Loop

• Preventing the execution of code during the first iteration

Timed Structures

Use the Timed Structures and VIs to control the rate and priority at which a timed
structure executes its subdiagram, synchronize the start time of timed structures,
create timing sources, and establish a hierarchy of timing sources.

The VIs and functions on this palette can return Timed Loop Error Codes.

Palette
Description
Object
Executes one or more subdiagrams, or frames, sequentially each iteration of the loop
Timed Loop at the period you specify. Use the Timed Loop when you want to develop VIs with
multirate timing capabilities, precise timing, feedback on loop execution, timing

© National Instruments 335


Functions

Palette
Description
Object
characteristics that change dynamically, or several levels of execution priority. Right-
click the structure border to add, delete, insert, and merge frames.
A Timed Sequence structure consists of one or more subdiagrams, or frames, timed
by an internal or external timing source that execute sequentially. A Timed Sequence
structure executes each frame only once and, unlike a Timed Loop, does not repeat
Timed
iterations. Use the Timed Sequence structure when you want to develop VIs that
Sequence
execute only once with precise timing, execution feedback, timing characteristics
that change dynamically, or several levels of execution priority. Right-click the Timed
Sequence structure border to add, delete, insert, and merge frames.

Creates a 1 kHz, 1MHz, or software-triggered timing source you can use to control the
Create
execution of a timed structure. Each timing source has its own unit of timing and/or
Timing
start time and does not start until the first timed structure that uses the timing source
Source
starts. You must manually select the polymorphic instance you want to use.

Fire
Software-
Fires a software-triggered timing source. Use the Create Timing Source VI to create a
Triggered
software-triggered timing source.
Timing
Source

Clear Stops and deletes the timing source you created or specified for use by another
Timing resource. The VI clears the timing source when the current iterations of all active
Source timed structures that reference the timing source complete.

Synchronize
Synchronizes the start of Timed Loops or Timed Sequence structures you enter in
Timed
timed structure names by adding the names to the synchronization group you
Structure
specify in synchronization group name.
Starts

Stop Timed Aborts the execution of the Timed Loop or Timed Sequence structure you enter in
Structure name.

Build
Timing Creates a hierarchy of timing sources based on the names you enter in timing source
Source names.
Hierarchy

336 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Structures\Timed Loop\Timed Loop.lvproj

Timed Loop

Executes one or more subdiagrams, or frames, sequentially each iteration of the loop
at the period you specify. Use the Timed Loop when you want to develop VIs with
multirate timing capabilities, precise timing, feedback on loop execution, timing
characteristics that change dynamically, or several levels of execution priority. Right-
click the structure border to add, delete, insert, and merge frames.

Components of a Timed Loop

Note If you use the Timed Loop in an FPGA VI, you must use a single-cycle
Timed Loop. A single-cycle Timed Loop executes one subdiagram per FPGA
clock cycle. Single-cycle Timed Loops do not support frames.

The iteration (i) terminal provides the current loop iteration count, which is zero for

© National Instruments 337


Functions

the first iteration. If iteration count exceeds 2,147,483,647, or 231-1, the iteration
terminal remains at 2,147,483,647 for all further iterations. If you need to keep count of
more than 2,147,483,647 iterations, you can use shift registers with a greater integer
range.

The Timed Loop includes the (1) Input and (4) Output nodes, and (2) Left and (3) Right
Data nodes for each frame, as shown in the previous illustration. By default, nodes of
the Timed Loop do not display all of the available input and output terminals. You can
resize nodes or right-click a node and use the shortcut menu to display node
terminals. Right-click the border of a Timed Loop and select Show Left Data Node or
Show Right Data Node from the shortcut menu to display each node.

Double-click the Input Node or right-click the structure and select Configure Timed
Loop to display the Configure Timed Loop dialog box, where you can configure the
Timed Loop. The values you enter in the Configure Timed Loop dialog box appear next
to the input terminals on the Input Node.

The following table lists node terminals of the Timed Loop. The Timed Loop includes
many nodes whose values are relative to the start of the timing source. If you do not
request synchronization, the start time of the timing source is the start time of the first
loop that uses the timing source. If multiple loops are part of a synchronization group,
the start time of the timing source is when the last loop is ready to execute.

(1) Input Node

Specifies the time when the Timed Loop must complete the iteration. The
deadline value is relative to the start of the timing source and is specified in units
Deadline of the timing source. Specifying a value of -1 indicates no deadline. If you do not
specify a value for this input, the structure uses the value of Period as the deadline
value.
Propagates errors through the structure. The Timed Loop does not execute if Error
Error
receives an error condition.
Specifies how the Timed Loop handles late executions. There are five available
modes—No change, Process missed periods maintaining original phase, Process
Mode
missed periods ignoring original phase, Discard missed periods maintaining
original phase, and Discard missed periods ignoring original phase.
Structure Specifies a name for the Timed Loop.

338 ni.com
Functions

Name
Specifies the length of time a Timed Loop waits to begin execution. The offset
Offset value is relative to the start of the timing source and is specified in units of the
timing source.
Specifies a period for the Timed Loop in the same units as the timing source
specified by Source Name.

Note Do not set the period of a Timed Loop to 0. National Instruments


does not support applications that contain Timed Loops with periods
Period
of 0 because these periods cause undefined application behavior. If
you need a loop that runs as fast as possible combined with the priority
execution features of a Timed Loop, use a While Loop inside a Timed
Sequence structure instead.

Specifies the priority of the execution of the Timed Loop. The priority of a timed
structure specifies when the structure executes on the block diagram relative to
Priority
other objects on the block diagram. The value for the Priority input must be a
positive integer between 1 and 65,535.
Specifies the processor you want to handle execution. The default is -2, which
means LabVIEW automatically assigns a processor. To manually assign a
Processor processor, enter a number between 0 and 255, where 0 represents the first
processor. If you enter a number that exceeds the number of available processors,
you generate a run-time error and the timed structure does not execute.
Specifies the name of the timing source to use for controlling the structure. The
Source
timing source must be created on the block diagram using the Create Timing
Name
Source VI or selected from the Configure Timed Loop dialog box.
Specifies the maximum amount of time a Timed Loop can wait to begin execution.
The default is -1,which means that no timeout is specified for the next frame. The
Timeout
timeout value is relative to the start of the timing source or the end of the previous
iteration and is specified in units of the frame timing source.

(2) Left Data Node

Actual End
[f-1] Returns the actual end time for the previous frame (f-1). The actual end value is
(Unavailable relative to the start time of the timing source and is specified in units of the timing
in singe- source.
frame

© National Instruments 339


Functions

Timed
Loop)
Actual End Returns the actual end time for the previous iteration (i-1). The actual end value is
[i-1] (First relative to the start time of the timing source and is specified in units of the timing
frame only) source.
Actual Start
[f]
(Unavailable Returns the actual start time of the current frame (f). The actual start value is relative
in single- to the start time of the timing source and is specified in units of the frame timing
frame source.
Timed
Loop)
Actual Start Returns the actual start time of the current iteration (i). The actual start value is
[i] (First relative to the start time of the timing source and is specified in units of the timing
frame only) source.
Deadline Returns the deadline value for the current frame.
Error Propagates errors through the structure.
Expected
End [f-1]
(Unavailable Returns the expected end time for the previous frame (f-1). The expected end value is
in single- relative to the start time of the timing source and is specified in units of the timing
frame source. The expected end (f-1) is equal to the start of the next period.
Timed
Loops)
Expected
Returns the expected end time for the previous iteration (i-1). The expected end
End [i-1]
value is relative to the start time of the timing source and is specified in units of the
(First frame
timing source.
only)
Returns the expected start time of the current frame (f). The expected start value is
Expected
relative to the start time of the timing source and is specified in units of the frame
Start [f]
timing source.
Expected
Returns the expected start time of the current iteration (i). The expected start value is
Start [i]
relative to the start time of the timing source and is specified in units of the timing
(First frame
source.
only)
Finished Returns TRUE if the Timed Loop does not complete the previous frame before the
Late? [f-1] specified deadline.

340 ni.com
Functions

Finished
Late? [i-1] Returns TRUE if the Timed Loop does not complete the previous iteration before the
(First frame specified deadline.
only)
Frame
Duration
(Unavailable
Returns the duration time of the previous frame. The frame duration is relative to the
in single-
start of the frame and is specified in units of the frame timing source.
frame
Timed
Loops
Returns the end time of the previous iteration or frame in nanoseconds. If the timed
loop uses an absolute timing source, Global End Time returns a timestamp.
Global End Otherwise, Global End Time returns a 64-bit integer. If the timed loop runs on an RT
Time target, Global End Time is based on the system time of the target and can be
synchronized with an external clock. If the timed loop runs on Windows, Global End
Time is based on the Windows system time.
Returns the start time of the current iteration or frame in nanoseconds. If the timed
loop uses an absolute timing source, Global Start Time returns a timestamp.
Global Start Otherwise, Global Start Time returns a 64-bit integer. If the timed loop runs on an RT
Time target, Global Start Time is based on the system time of the target and can be
synchronized with an external clock. If the timed loop runs on Windows, Global Start
Time is based on the Windows system time.
Iteration
Returns a time stamp of the duration of the previous iteration. The iteration duration
Duration
value is relative to the start of the iteration and is specified in units of the timing
(First frame
source.
only)
Mode (First
Returns the mode value for the current iteration.
frame only)
Offset (First
Returns the offset value for the start of the current iteration.
frame only)
Period (First
Returns the period value for the current frame.
frame only)
Priority Returns the priority value for the current frame.
Returns the processor you assigned to handle execution, if you assigned one.
Processor
Otherwise, returns -2, which means LabVIEW automatically assigned a processor.
Start
Returns the start value for the current frame.
(Unavailable

© National Instruments 341


Functions

in first
frame)
Timeout Returns the timeout value for the current frame.
Returns an enumerated type with the reason for the execution start of the current
Wakeup
iteration. The possible values are 0 for Normal, 1 for Aborted, 2 for Asynchronous
Reason
wakeup, 3 for a Timing source error, 4 for a Timed loop error, and 5 for Timeout.

(3) Right Data Node

Specifies the time when the Timed Loop must complete the next frame. The
Deadline deadline value is relative to the start of the next frame and is specified in units
of the timing source. The default is -1, which means unchanged.
Propagates errors or warnings out of the Timed Loop subdiagram. If Error
receives an error condition, the Timed Loop executes the next frame untimed. If
Error Error receives an error condition in the last frame, the structure finishes
executing the current iteration untimed, exits the loop, and returns the error
condition on the Output node.
Specifies the Mode for the next iteration of the Timed Loop. There are five
Mode (Last available modes—No change, Process missed periods maintaining original
frame only) phase, Process missed periods ignoring original phase, Discard missed periods
maintaining original phase, and Discard missed periods ignoring original phase.
Specifies the length of time the next iteration waits to begin execution. The
Offset (Last offset value is relative to the start of the next iteration and is specified in units of
frame only) the timing source. The default is -1, which means unchanged. If you set an
offset for the next iteration, you must set a new Mode value.
Specifies a period for the next iteration of a Timed Loop in units as the timing
source. The default is -1, which means unchanged.

Note Note: Do not set the period of a Timed Loop to 0. National


Period (Last Instruments does not support applications that contain Timed
frame only) Loops with periods of 0 because these periods cause undefined
application behavior. If you need a loop that runs as fast as possible
combined with the priority execution features of a Timed Loop, use a
While Loop inside a Timed Sequence structure instead.

Specifies the Priority for the next iteration of the Timed Loop. The priority
Priority specifies when the next iteration executes on the block diagram relative to
other objects on the block diagram. The value for the Priority input must be a

342 ni.com
Functions

positive integer between 1 and 65,535.


Specifies the processor you want to handle execution. The default is -1, which
means LabVIEW assigns the same processor specified in the Input node. Enter
-2 to allow LabVIEW to assign the processor. To manually assign a processor,
Processor enter a number between 0 and 255, where 0 represents the first available
processor. If you enter a number that exceeds the number of available
processors, you generate a run-time error and the timed structure does not
execute.
Start
Specifies the length of time the next frame waits to start execution. The start
(Unavailable
value is relative to the beginning of the current frame and is specified in units of
in last
the timing source.
frame)
Specifies the maximum amount of time the next iteration can wait to begin
execution. The default is -1, which means that no timeout is specified for the
Timeout
next iteration. The timeout value is relative to the end of the previous iteration
and is specified in units of the frame timing source.

(4) Output Node

Actual End
[f-1]
(Unavailable Returns the actual end time for the previous frame (f-1). The actual end value is
in single- relative to the start time of the timing source and is specified in units of the timing
frame source.
Timed
Loops)
Returns the actual end time for the previous iteration (i-1). The actual end value is
Actual End
relative to the start time of the timing source and is specified in units of the timing
[i-1]
source.
Propagates errors received by the Timed Loop and returns errors from the
Error
subdiagram.
Expected
End [f-1]
Returns the expected end time for the previous frame (f-1). The expected end value is
(Unavailable
relative to the timing source if the frame timing source is not reset at the beginning of
in single-
the iterations. The expected end value is specified in units of the timing source. The
frame
expected end (f-1) is equal to the start of the next period.
Timed
Loops)

© National Instruments 343


Functions

Returns the expected end time for the previous iteration (i-1). The expected end
Expected value is relative to the timing source if the frame timing source is not reset at the
End [i-1] beginning of the iterations. The expected end value is specified in units of the timing
source.
Finished
Late? [f-1]
(Unavailable
Returns TRUE if the Timed Loop does not complete the previous frame before the
in single-
specified deadline.
frame
Timed
Loops)
Finished Returns TRUE if the Timed Loop does not complete the previous iteration before the
Late? [i-1] specified deadline.
Frame
Duration
(Unavailable
Returns the duration time of the previous frame. The frame duration is relative to the
in single-
start of the frame and is specified in units of the frame timing source.
frame
Timed
Loops)
Returns the end time of the previous iteration or frame in nanoseconds. If the timed
loop uses an absolute timing source, Global End Time returns a timestamp.
Global End Otherwise, Global End Time returns a 64-bit integer. If the timed loop runs on an RT
Time target, Global End Time is based on the system time of the target and can be
synchronized with an external clock. If the timed loop runs on Windows, Global End
Time is based on the Windows system time.
Returns a time stamp of the execution length of the previous iteration. The iteration
Iteration
duration is relative to the start of the iteration and is specified in units of the timing
Duration
source.
Returns the processor you assigned to handle execution, if you assigned one.
Processor
Otherwise, returns -2, which means LabVIEW automatically assigned a processor.

Refer to the Configuring Timed Loops topic for more information about using and
configuring the Timed Loop.

To convert a Timed Loop to a While Loop, right-click the Timed Loop and select
Replace with While Loop from the shortcut menu. To convert a Timed Loop to a Timed
Sequence structure, right-click the Timed Loop and select Replace with Timed

344 ni.com
Functions

Sequence from the shortcut menu.

Unlike the While Loop, the Timed Loop does not require wiring to the stop terminal. If
you do not wire anything to the stop terminal, the loop will run interminably.

Refer to the Timed Loop (FPGA Module) topic for more information about using and
configuring the Timed Loop in FPGA Vis.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Structures\Timed Loop\Timed Loop


Offset.vi
• labview\examples\Structures\Timed Loop\Timed Loop
Resettable Source Type.vi

Timed Sequence

A Timed Sequence structure consists of one or more subdiagrams, or frames, timed by


an internal or external timing source that execute sequentially. A Timed Sequence
structure executes each frame only once and, unlike a Timed Loop, does not repeat
iterations. Use the Timed Sequence structure when you want to develop VIs that
execute only once with precise timing, execution feedback, timing characteristics that
change dynamically, or several levels of execution priority. Right-click the Timed
Sequence structure border to add, delete, insert, and merge frames.

The Timed Sequence structure includes the (1) Input and (4) Output nodes, and (2) Left
and (3) Right Data nodes for each frame, as shown in the previous illustration. By
default, nodes of the Timed Sequence structure do not display all of the available
input and output terminals. You can resize nodes or right-click a node and use the
shortcut menu to display node terminals. Right-click the border of a Timed Sequence
structure and select Show Left Data Node or Show Right Data Node from the shortcut
menu to display each node.

Double-click the Input Node to display the Configure Timed Sequence dialog box,
where you can configure the Timed Sequence structure. The values you enter in the
Configure Timed Sequence dialog box appear as options in the Input Node.

© National Instruments 345


Functions

The following table lists node terminals of the Timed Sequence structure.

(1) Input Node

Specifies the time when the first frame must complete. The deadline value is
Deadline relative to the start of the Timed Sequence structure and is specified in units of
the frame timing source. Specifying a value of -1 indicates no deadline.
Propagates errors through the structure. The Timed Sequence structure does not
Error
execute if Error receives an error condition.
Structure
Specifies a name for the Timed Sequence structure.
Name
Specifies the length of time a Timed Sequence structure waits to begin execution
Offset of the first frame. The offset value is relative to the start of the Timed Sequence
structure and is specified in units of the timing source.
Specifies the priority for the execution of the Timed Sequence structure. The
priority specifies when the Timed Sequence structure executes on the block
Priority
diagram relative to other objects on the block diagram. The value for the Priority
input must be a positive integer between 1 and 65,535.
Specifies the processor you want to handle execution. The default is -2, which
means LabVIEW automatically assigns a processor. To manually assign a
Processor processor, enter a number between 0 and 255, where 0 represents the first
processor. If you enter a number that exceeds the number of available processors,
you generate a run-time error and the timed structure does not execute.
Specifies the name of the timing source to use for controlling the structure. The
Source
timing source must be created on the block diagram using the Create Timing
Name
Source VI or selected from the Configure Timed Sequence dialog box.
Specifies the maximum amount of time a Timed Sequence structure can wait to
begin execution of the first frame. The default is -1, which means that no timeout
Timeout
is specified for the next frame. The timeout value is relative to the start of the
structure and is specified in units of the frame timing source.

(2) Left Data Node

Actual End
Returns the actual end time for the previous frame (f-1). The actual end value is
[f-1]
relative to the start time of the Timed Sequence structure and is specified in units
(Unavailable in
of the frame timing source.
first frame)

346 ni.com
Functions

Actual Start [i] Returns the actual start time of the current iteration (i). The actual start value is
(First frame relative to the start time of the Timed Sequence structure and is specified in units
only) of the structure timing source.
Returns the actual start time of the current frame (f). The actual start value is
Actual Start [f] relative to the start time of the Timed Sequence structure and is specified in units
of the frame timing source.
Deadline Returns the deadline value for the current frame.
Error Propagates errors through the structure.
Expected End
Returns the expected end time for the previous frame (f-1). The expected end value
[f-1]
is relative to the start time of the Timed Sequence structure and is specified in
(Unavailable in
units of the frame timing source.
first frame)
Expected Start Returns the expected start time of the current iteration (i). The expected start value
[i] (First frame is relative to the start time of the Timed Sequence structure and is specified in
only) units of the structure timing source.
Returns the expected start time of the current frame (f). The expected start value is
Expected Start
relative to the start time of the Timed Sequence structure and is specified in units
[f]
of the frame timing source.
Finished Late?
[f-1] Returns TRUE if the Timed Sequence structure does not complete the previous
(Unavailable in frame before the specified deadline.
first frame)
Frame
Duration Returns the duration time of the previous frame. The frame duration is relative to
(Unavailable in the start of the frame and is specified in units of the frame timing source.
first frame)
Global End
Time
Returns a time stamp for the end of the previous frame in nanoseconds.
(Unavailable in
first frame)
Global Start
Returns a time stamp for the start of the current frame in nanoseconds.
Time
Offset (First
Returns the offset value for the start of the first frame.
frame only)
Priority Returns the priority value for the current frame.
Processor Returns the processor you assigned to handle execution, if you assigned one.

© National Instruments 347


Functions

Otherwise, returns -2, which means LabVIEW automatically assigned a processor.


Start
(Unavailable in Returns the start time for the current frame.
first frame)
Timeout Returns the timeout value for the current frame.
Returns an enumerated type with the reason for the execution start of the current
Wakeup
iteration. The possible values are 0 for Normal, 1 for Aborted, 2 for Asynchronous
Reason
wakeup, 3 for a Timing source error, 4 for a Timed loop error, and 5 for Timeout.

(3) Right Data Node

Deadline
Specifies the time when the next frame must complete. The deadline value is
(Unavailable
relative to the start of the next frame and is specified in units of the frame
in last
timing source. The default is -1, which means unchanged.
frame)
Propagates errors through the structure. If Error receives an error condition, the
Error
Timed Sequence structure executes the next frame untimed.
Specifies the priority for the execution of the next frame. The priority specifies
Priority
when the next frame executes on the block diagram relative to other objects on
(Unavailable
the block diagram. The value for the Priority input must be a positive integer
in last
between 1 and 65,535. The default is -1, which means no change from the
frame)
priority value of the previous frame.
Specifies the processor you want to handle execution. The default is -1, which
means LabVIEW assigns the same processor specified in the Input node. Enter
-2 to allow LabVIEW to assign the processor. To manually assign a processor,
Processor enter a number between 0 and 255, where 0 represents the first available
processor. If you enter a number that exceeds the number of available
processors, you generate a run-time error and the timed structure does not
execute.
Start
The start time specifies the time the next frame should start executing. Specify
(Unavailable
a start time value relative to the start of the current frame in units of the frame
in last
timing source. The default is -1, which means unspecified.
frame)
Timeout Specifies the maximum amount of time the next frame can wait to begin
(Unavailable execution. The default is -1, which means that no timeout is specified for the
in last next frame. The timeout value is relative to the end time of the current frame
frame) and is specified in units of the frame timing source.

348 ni.com
Functions

(4) Output Node

Returns the actual end time for the final frame (f-1). The actual end value is relative to
Actual
the start time of the Timed Sequence structure and is specified in units of the frame
End [f-1]
timing source.
Propagates errors received by the Timed Sequence structure and returns errors from
Error
the frames.
Returns the expected end time for the final frame (f-1). The expected end value is
Expected
relative to the timed structure if the frame timing source is not reset at the beginning of
End [f-1]
the iterations. The expected end value is specified in units of the timing source.
Finished
Late? Returns TRUE if the final frame does not complete before the specified deadline.
[f-1]
Frame Returns the duration time of the previous frame. The frame duration is relative to the
Duration start of the frame and is specified in units of the frame timing source.
Global
Returns a time stamp for the end of the previous frame in nanoseconds.
End Time
Returns a time stamp of the execution length of all of the frames. The iteration duration
Iteration
is relative to the start of the Timed Sequence structure and is specified in units of the
Duration
timing source.
Returns the processor you assigned to handle execution, if you assigned one.
Processor
Otherwise, returns -2, which means LabVIEW automatically assigned a processor.

Refer to the Configuring Timed Sequence Structures topic for information about using
and configuring the Timed Sequence structure.

To convert a Timed Sequence structure to a Timed Loop, right-click the Timed


Sequence structure and select Replace with Timed Loop from the shortcut menu. To
convert a Timed Sequence structure to a Flat Sequence structure, right-click the Timed
Sequence structure and select Replace with Flat Sequence from the shortcut menu.

© National Instruments 349


Functions

Create Timing Source

Creates a 1 kHz, 1MHz, or software-triggered timing source you can use to control the
execution of a timed structure. Each timing source has its own unit of timing and/or
start time and does not start until the first timed structure that uses the timing source
starts. You must manually select the polymorphic instance you want to use.

• Create 1kHz Source


• Create 1MHz Source
• Create Software-Triggered Timing Source

Create 1kHz Source


Creates a 1 kHz, 1MHz, or software-triggered timing source you can use to control the
execution of a timed structure. Each timing source has its own unit of timing and/or
start time and does not start until the first timed structure that uses the timing source
starts. You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• name (in) —

name is the name of the timing source you want to create.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• name (out) —

350 ni.com
Functions

name (out) is the name of the timing source the VI created.

• error out —

error out contains error information. This output provides standard error out functionality.

Create 1MHz Source


Creates a 1 kHz, 1MHz, or software-triggered timing source you can use to control the
execution of a timed structure. Each timing source has its own unit of timing and/or
start time and does not start until the first timed structure that uses the timing source
starts. You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• name (in) —

name is the name of the timing source you want to create.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• name (out) —

name (out) is the name of the timing source the VI created.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 351


Functions

Create Software-Triggered Timing Source


Creates a 1 kHz, 1MHz, or software-triggered timing source you can use to control the
execution of a timed structure. Each timing source has its own unit of timing and/or
start time and does not start until the first timed structure that uses the timing source
starts. You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• trigger ID —

trigger ID is the numeric identifier of the software-triggered timing source. The valid range of
trigger ID values is 0-127. Because this parameter is implemented as an integer rather than a
string, it is safe to use the Fire Software-Triggered Timing Source VI in time-critical code.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• timing source name —

timing source name is the name of the timing source created by the VI. Wire this output to the
Source Name input of a timed structure.

• error out —

error out contains error information. This output provides standard error out functionality.

Fire Software-Triggered Timing Source

Fires a software-triggered timing source. Use the Create Timing Source VI to create a
software-triggered timing source.

352 ni.com
Functions

Inputs/Outputs
• trigger ID —

trigger ID is the numeric identifier of the software-triggered timing source. The valid range of
trigger ID values is 0-127. Because this parameter is implemented as an integer rather than a
string, it is safe to use the Fire Software-Triggered Timing Source VI in time-critical code.

• number of ticks —

number of ticks specifies the number of ticks to increment the internal tick counter of the
timing source. The default value is 1 tick.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• trigger ID out —

trigger ID out returns trigger ID unchanged.

• error out —

error out contains error information. This output provides standard error out functionality.

When you use a software-triggered timing source to control a Timed Loop, you can use
the number of ticks input to trigger multiple successive Timed Loop iterations. When
the internal tick counter jumps past one or more Timed Loop periods, the Timed Loop
regards those periods as missed periods. If you remove the checkmark from the
Discard missed periods checkbox on the Configure Timed Loop dialog box, a single
call to this VI can trigger the Timed Loop to execute multiple iterations.

Clear Timing Source

Stops and deletes the timing source you created or specified for use by another
resource. The VI clears the timing source when the current iterations of all active timed
structures that reference the timing source complete.

© National Instruments 353


Functions

If the timing source is associated with a DAQmx task, the VI also clears the task.

Inputs/Outputs
• name —

name is the name of the timing source you want to stop and delete.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• parent —

parent is the name of the parent of the timing source the VI deleted. If the timing source has no
parent, parent is empty.

• error out —

error out contains error information. This output provides standard error out functionality.

Synchronize Timed Structure Starts

Synchronizes the start of Timed Loops or Timed Sequence structures you enter in
timed structure names by adding the names to the synchronization group you specify
in synchronization group name.

All timed structures in a synchronization group wait until all the structures are ready to
execute.

354 ni.com
Functions

Inputs/Outputs
• clear (F) —

clear, if TRUE, removes all timed structures from synchronization group name before adding
the timed structures in timed structure names to the group.

Set clear to TRUE to remove any timed structures that do not correspond to a Timed Loop. The
default is FALSE.

• replace (T) —

replace replaces the timed structures in synchronization group name with the timed structures
you enter in timed structure names.

If replace is FALSE and the timing source is a member of another hierarchy, the VI returns an
error.

• synchronization group name —

synchronization group name is the name for the group of timed structures you want to
synchronize.

• timeout ms (10000) —

timeout ms specifies the time, in milliseconds, that a timed structure waits on other members of
the synchronization group to arrive at the synchronization point.

If any of the timed structures in the group do not arrive in time, the timed structure returns an
error. The default is 10,000 ms. A value of –1 indicates to wait indefinitely.

• timed structure names —

timed structure names specifies the names of the timed structures you want to synchronize.

By default, the VI deletes the timed structure from its current group and adds it to the group you
specify in synchronization group name. If you set replace to FALSE and a timed structure you
specify in timed structure names is a member of another group, the VI returns an error to
indicate that it could not add the timed structure to the synchronization group.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

© National Instruments 355


Functions

• timed structures names out —

timed structures names out returns the names of all timed structures in the group after
LabVIEW adds the names to the synchronization group you specify.

• error out —

error out contains error information. This output provides standard error out functionality.

Use this VI only with timed structures configured to use either the 1 kHz Clock timing
source or the 1 MHz Clock timing source. National Instruments does not recommend
using this VI with absolute time timing sources, reset at structure start timing sources,
the Synchronize to Scan Engine timing source, or any external timing source.

Stop Timed Structure

Aborts the execution of the Timed Loop or Timed Sequence structure you enter in
name.

If you attempt to abort a running Timed Loop, the Timed Loop immediately executes
the current iteration and returns Aborted in the Wakeup Reason output of the Left
Data node.

Related Information

Aborting the Execution of a Timed Structure (Real-Time, Windows)

Inputs/Outputs
• priority —

priority changes the priority of the timed structure you are stopping. Use priority when you
want to stop two or more timed structures and want to ensure one stops before the other.

• name —

356 ni.com
Functions

name is the name of the timed structure you want to stop.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Structures\Timed Loop\Timed Loop


Abort.vi

Build Timing Source Hierarchy

Creates a hierarchy of timing sources based on the names you enter in timing source
names.

Inputs/Outputs
• replace (F) —

replace (F) replaces any timing source you entered in timing source names if a timing source by
that name already exists in the hierarchy of timing sources.

• hierarchy name —

hierarchy name is the name of the timing source hierarchy you want to create.

© National Instruments 357


Functions

• parent —

parent is the valid timing source you want to start after the all the timing sources in hierarchy
name start.

• timing source names —

timing source names is an array of names of the timing sources you want to add to the timing
source hierarchy.

If replace is TRUE, the new timing source replaces any timing source with the same name that
already exists in the timing source hierarchy. These timing sources start before the timing source
you enter in parent.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• error out —

error out contains error information. This output provides standard error out functionality.

The hierarchy determines the order in which the timing sources start. The parent
timing source does not start until after the timing sources in hierarchy name start. Use
this VI when you have timing sources that have signal dependencies, such as DAQ
counters routed to drive analog input connections. In such a case, the counter timing
source acts as the parent.

Case Structure

Contains one or more subdiagrams, or cases, exactly one of which executes when the
structure executes. The value wired to the case selector determines which case to
execute.

358 ni.com
Functions

Components of a Case Structure

• Selector label—Displays the value(s) for which the associated case executes. You
can specify a single value or a range of values. You also can use the selector label to
specify a default case.
• Subdiagram(case)—Contains the code that executes when the value wired to
the case selector matches the value that appears in the selector label. To modify
the number or order of subdiagrams, right-click the border of the Case structure
and select the appropriate option.
• Case selector—Selects which case to execute based on the value of the input
data. The input data can be a Boolean, string, integer, enumerated type or error
cluster. The data type you wire to the case selector determines the allowed cases
you can enter in the selector label.

Configuring a Case Structure

• Creating a basic Case structure


• Quickly wiring an output tunnel for all cases

Rearranging a Case Structure

• Adding subdiagrams between other subdiagrams


• Moving between subdiagrams
• Shifting subdiagrams to a different position in the order of subdiagrams

© National Instruments 359


Functions

• Swapping the subdiagrams of two cases


• Removing a Case structure without deleting contained code

Troubleshooting a Case Structure

• Preventing indicators from resetting to default values


• Missing string values of enumerated controls

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Structures\Case Structure\Case Structure


- Selector Data Types.vi

Event Structure

Waits until an event occurs, then executes the appropriate case to handle that event.
The Event structure has one or more subdiagrams, or event cases, exactly one of which
executes when the structure executes to handle an event. This structure can time out
while waiting for notification of an event. Wire a value to the Timeout terminal at the
top left of the Event structure to specify the number of milliseconds the Event
structure waits for an event. The default is -1, which indicates never to time out.

You can configure a single event case to handle multiple events , but only one of these
events within the event case can occur at a time. You must place the Event structure in
a While loop to handle multiple events.

A single case in the Event structure cannot handle both notify and filter events . A case
can handle multiple notify events but can handle multiple filter events only if the
event data items are identical for all events. You can configure any number of Event
structures to respond to the same notify event or filter event on a specific object.

Before you configure events for the Event structure to handle, review the caveats and
recommendations for using events in LabVIEW.

360 ni.com
Functions

Event Structure Components

The following example shows an Event structure with the Key Down? event case.

• —The event selector label specifies which events cause the currently displayed
case to execute. To view other event cases, click the down arrow next to the case
name.
• — The Timeout terminal specifies the number of milliseconds to wait for an
event before timing out. If you wire a value to the Timeout terminal, you must
provide a Timeout event case to avoid an error.
• — The dynamic event terminals accept an event registration refnum or a cluster
of event registration refnums for dynamic event registration . If you wire the inside
right terminal, that terminal no longer carries the same data as the left terminal.
You can wire the event registration refnum or cluster of event registration refnums
to the inside right terminal through a Register For Events function and modify the

© National Instruments 361


Functions

event dynamically . Depending on the palette from which you select the Event
structure, the dynamic event terminals might not appear by default. To display
these terminals, right-click the Event structure and select Show Dynamic Event
Terminals from the shortcut menu.
• —

The Event Data Node identifies the data LabVIEW returns when an event occurs.
Like the Unbundle By Name function, you can resize the node vertically and select
the items you need. Use the Event Data Node to access event data elements, such
as Type and Time, which are common to all events. Other event data elements,
like Char and VKey for example, vary based on the event you configure. You can
show or hide the Event Data Node for a case when all data items are unused. Right-
click the structure border and select Visible Items»Event Data Node for This Case
to show or hide the Event Data Node. You cannot hide a node when it is wired or
when it is inside a filter event case.

Note For more information about event data elements, click the Details
link in the event descriptions for the Control, Application, Pane, and VI
event class topics.

• — The Event Filter Node identifies the event data you can modify before the user
interface can process that data. This node appears in Event structure cases that
handle filter events . If you want to change event data, you can wire and modify
data items from the Event Data Node to the Event Filter Node. You also can change
the event data by wiring new values to the node terminals. To completely discard
an event, wire a TRUE value to the Discard? terminal. If you do not wire a value to a
data item of the Event Filter Node, that data item remains unchanged.
• — Like a Case structure, the Event structure supports tunnels. However, by
default you do not have to wire Event structure output tunnels in every case. All
unwired tunnels use the default value for the tunnel data type. Right-click a tunnel
and deselect Use Default If Unwired from the shortcut menu to revert to the
default Case structure behavior where tunnels must be wired in all cases. You also
can configure the tunnels to wire the input and output tunnels automatically in
unwired cases.

362 ni.com
Functions

In Place Element Structure

Controls how the LabVIEW compiler performs certain operations and, in some cases,
increases memory and VI efficiency. Use the In Place Element structure when you
operate on a data element within an array, cluster, variant, or waveform without
requiring the LabVIEW compiler to copy data values and maintain those values in
memory. You also can use this structure to operate on any data type that you want to
maintain within the same data space in memory. Right-click the border of the
structure and select the border node that matches the operation you want to perform.

Right-click the border of the In Place Element structure and select from the following
nodes to add to the structure border:

• Array Index / Replace Elements border node


• Array Split / Replace Subarrays border node
• Unbundle / Bundle Elements border node
• Waveform Unbundle / Bundle Elements border node
• Variant To / From Element border node
• In Place In / Out Element border node
• Data Value Reference Read / Write Element border node
• Variant Attribute Get / Replace border node
• Map Get / Replace Value border node

You can right-click a node and select Mark As Modifier to indicate that LabVIEW
modifies the data you wire to the node, even if the block diagram does not indicate a
modification of data occurs. The Mark As Modifier option is useful when you work with
dynamic dispatch terminals. While the parent implementation of a dynamic dispatch
subVI might not modify the data wired to the node, a child implementation might
modify the data. Using the Mark As Modifier option then optimizes performance by
minimizing the number of copies of the data LabVIEW creates.

Note The Mark As Modifier option does not prevent access to the data and
cannot be used as a synchronization method. Instead, use semaphores or
data flow to control access to protected data and avoid race conditions.

© National Instruments 363


Functions

Array Index / Replace Elements

Right-click the border of an In Place Element structure and select the Add Array Index /
Replace Elements option from the shortcut menu to place this border node on the In
Place Element structure.

Inputs/Outputs
• array —

array specifies an n-dimensional array of any type.

• index —

index specifies the element you want to replace in the array. This border node gains an
additional index parameter for each additional dimension of the array in the array input.

• element —

• element —

• array —

array returns the array you input with the replaced element(s).

• index —

364 ni.com
Functions

index returns the element(s) you replaced in the array.

Use this border node to perform operations on an element or elements of an array and
return the elements to the same location or locations in the array. Each array element
you index with the border node on the left side of the structure must be placed back
into the array with the border node on the right side of the structure by wiring the
element back into the array. This border node allows the LabVIEW compiler to avoid
making a complete value copy of the array and array elements in memory.

The border node on the left side of the structure is similar to the Index Array function.
The border node on the right side of the structure is similar to the Replace Array
Subset function.

Unbundle / Bundle Elements

Right-click the border of an In Place Element structure and select the Add Unbundle /
Bundle Elements option from the shortcut menu to place this border node on the In
Place Element structure.

Inputs/Outputs
• input cluster —

input cluster is the cluster whose elements you want to access.

• element —

• element —

• output cluster —

output cluster is the resulting cluster.

© National Instruments 365


Functions

Use this border node to perform operations on one or more cluster elements and
replace the elements in the same location in the cluster. Each cluster element you
unbundle with the border node on the left side of the structure must be bundled back
into the cluster with the border node on the right side of the structure. This node
allows the LabVIEW compiler to avoid storing a complete value copy of the cluster and
cluster elements in memory.

The border node on the left side of the structure is similar to the Unbundle by Name
function. The border node on the right side of the structure is similar to the Bundle by
Name function.

Variant To / From Element

Right-click the border of an In Place Element structure and select the Add Variant To /
From Element option from the shortcut menu to place this border node on the In
Place Element structure.

Inputs/Outputs
• variant —

variant is the variant data you want to convert to the LabVIEW data type specified in type.

• type —

type is the LabVIEW data type to which you want to convert the variant data.

type can be any data type. However, this function returns an error if LabVIEW cannot convert the
data wired to variant to the data type you wire to this input. If the data is integers, you can
coerce the data to another numeric representation, such as an extended-precision, floating-
point number.

• data —

• error out —

366 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

This border node has error out terminals on both sides of the structure. The error output on the
left returns the actual error and the error output on the right duplicates the error from the left.
You need to wire only one of the error out terminals because they have the same error output.

• data —

• variant —

variant is the resulting variant data.

• error out —

Use this border node to perform operations on one or more variant data elements and
replace the variant data with the new data type in the same location in memory. Each
variant data element you retrieve with the border node on the left side of the structure
must be converted back to a variant with the border node on the right side of the
structure. This border node allows the LabVIEW compiler to avoid storing a complete
value copy of the variant and variant data elements in memory.

The border node on the left side of the structure is similar to the Variant to Data
function. The border node on the right side of the structure is similar to the To Variant
function.

In Place In / Out Element

Right-click the border of an In Place Element structure and select the Add In Place In /
Out Element option from the shortcut menu to place this border node on the In Place
Element structure.

Inputs/Outputs
• —

© National Instruments 367


Functions

• —

• —

• —

Use this border node to perform operations on any data type and return the resulting
data to the same location in memory. Each data element input on the left side of the
structure must be wired to the border node on the right side of the structure. This
border node allows the LabVIEW compiler to avoid moving the specified data to
different memory locations and can increase memory and execution efficiency.

The border node on the left side of the structure accepts any data type as an input. You
must wire the same data type from the border node on the left side of the structure to
the input on the border node on the right side of the structure.

Waveform Unbundle / Bundle Elements

Right-click the border of an In Place Element structure and select the Add Waveform
Unbundle / Bundle Elements option from the shortcut menu to place this border node
on the In Place Element structure.

Inputs/Outputs
• waveform —

waveform is the waveform from which you want to retrieve components.

• Y—

• Y—

• output waveform —

368 ni.com
Functions

output waveform is the resulting waveform. If you did not wire an existing waveform, this is a
new waveform. If you wired an existing waveform, this is the edited waveform.

Use this border node to perform operations on one or more waveform components
and replace the components to the same location in the waveform. Each waveform
component you retrieve with the border node on the left side of the structure must be
replaced back into the waveform with the border node on the right side of the
structure. This border node allows the LabVIEW compiler to avoid storing a complete
value copy of the waveform and waveform components in memory.

The border node on the left side of the structure is similar to the Get Waveform
Components function. The border node on the right side of the structure is similar to
the Build Waveform function.

Data Value Reference Read / Write Element

Accepts a data value reference or an external data value reference as an input, allows
you to operate on the data within the In Place Element structure, and replaces that
data in the original memory space. You can enable read-only access to the data value
reference by right-clicking the border node on the right of the structure and selecting
Allow Parallel Read-only Access. When the border node on the right is unwired,
LabVIEW allows multiple, concurrent read-only operations and does not modify the
data value reference.

Right-click the border of an In Place Element structure and select Add Data Value
Reference Read / Write Element from the shortcut menu to place this border node on
the In Place Element structure. You cannot find these border nodes in the palette
search or quick drop search.

Inputs/Outputs
• data value reference —

© National Instruments 369


Functions

data value reference is the reference that points to the data you want to access.

• data value —

data value is the data the reference points to.

Note LabVIEW cannot resize the data in an external data value reference. This node
produces an error if the array in an external data value reference is a different size
than the array you wire to the right side of the border node. If you wire an array with
more elements than are in the reference array to the border node on the right,
LabVIEW truncates the elements to fit in the reference array. If you wire an array with
fewer elements to the border node on the right, LabVIEW adds default data to the
reference array until it is filled.

• error out —

error out contains error information. This output provides standard error out functionality.

This border node has error out terminals on both sides of the structure. The error output on the
left returns the actual error and the error output on the right duplicates the error from the left.
You need to wire only one of the error out terminals because they have the same error output.

• data value —

• data value reference —

data value reference is the reference that points to the new data.

• error out —

Use this border node to operate on the data in place.

If a data value reference points to a class object, you cannot replace that class object
with a different LabVIEW class object inside the In Place Element structure. However,
you can replace any other object with an object of the same type.

Note This border node provides serialized access to the reference you wire
to the structure. When part of a VI obtains access to the reference, LabVIEW
blocks the rest of the VI or other VIs from simultaneous access. If you attempt

370 ni.com
Functions

to access a reference twice at the same time in the same structure, LabVIEW
returns a run-time error. If you attempt to access the reference after you
obtain access inside the In Place Element structure, the VI might hang. You
can enable multiple, concurrent read-only operations that do not modify the
data value reference by right-clicking the border node on the right of the
structure and selecting Allow Parallel Read-only Access.

Array Split / Replace Subarrays

Split an array into subarrays along a dimension you specify and operate on the
subarrays in place within the structure. Right-click the border of an In Place Element
structure and select the Add Array Split / Replace Subarrays option from the shortcut
menu to place this border node on the In Place Element structure.

Inputs/Outputs
• array —

array can be an n-dimensional array of any type.

• split length —

split length specifies the length of the resulting subarray. Each split length results in an
additional subarray. You must wire all or none of the split length inputs. If you do not wire any
split length inputs, LabVIEW automatically determines the length of the resulting subarray.

• element —

• element —

• element —

• element —

• array —

© National Instruments 371


Functions

array is the array this border node returns with the replaced element(s), row(s), column(s), or
page(s).

• split length —

split length indicates the length of the resulting subarray.

This border node allows the LabVIEW compiler to avoid making a complete value copy
of the array and array elements in memory.

Right-click this border node and select Split Dimension to specify in which dimension
to split the array. For example, if you select 1 for a two-dimensional array, LabVIEW
creates the subarrays from columns of the original array. If you select 0, LabVIEW
creates the subarrays from rows of the original array.

If you wire more elements than are in the original array to the border node on the right
side of the structure, LabVIEW truncates the elements to fit in the original memory
space. If you wire fewer elements than are in the original array to the border node,
LabVIEW adds additional array elements to fill the original memory space.

Variant Attribute Get / Replace

Right-click the border of an In Place Element structure and select the Add Variant
Attribute Get / Replace option from the shortcut menu to place this border node on
the In Place Element structure.

Inputs/Outputs
• variant —

variant specifies the variant for which you want to retrieve or change an attribute.

• attribute name —

372 ni.com
Functions

attribute name specifies the name of the attribute whose value you want to retrieve or change.

• attribute —

attribute returns the original value of the attribute if found? is TRUE. This parameter returns an
empty attribute if found? is FALSE.

• found? —

found? returns TRUE if the attribute was found with the specified attribute name and the
specified attribute name is not a duplicate name of a previously found attribute. The indicator
returns FALSE if the specified attribute name was not found, or if the specified attribute name
was a duplicate name of a previously found attribute.

• attribute —

attribute specifies the retrieved or changed value of the attribute.

• variant —

variant returns the variant with the retrieved or changed attribute.

• attribute name —

attribute name returns the name of the retrieved or changed attribute.

• found? —

Use this border node to access and modify one or more attributes of a variant without
copying the attributes out of the variant. Each attribute value you retrieve with the
border node on the left side of the structure must be replaced with an attribute value
using the border node on the right side of the structure.

The border node on the left side of the structure is similar to the Get Variant Attribute
function. The border node on the right side of the structure is similar to the Set Variant
Attribute function.

Note If the attribute with the specified attribute name is not found by the
node on the left side of the structure, the node on the right side of the
structure ignores the attribute. To allow the node on the right side to add the

© National Instruments 373


Functions

attribute to the variant if the attribute was not found, refer to the example
listed in the Example section for an illustration of how to add the syntax to
this border node.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Performance\Variant Attribute Lookup


Table\Variant Attribute Lookup Table.vi

Map Get / Replace Value

Use this border node to access and modify a value in a map without copying the value
out of the map. Use the border node on the left side of the structure to retrieve a value
in a map. Use the border node on the right side of the structure to modify or discard
the retrieved value.

To place this border node on the In Place Element structure, right-click the border of
an In Place Element structure and select the Add Map Get / Replace Value option from
the shortcut menu. Alternatively, you can use the In Place Map Access VI, which places
an In Place Element structure on the block diagram with this border node added.

Inputs/Outputs
• map —

map specifies the map in which you want to look for a key. This input accepts a map of any data
type. The default data type is a map of 32-bit signed integers.

• key —

key specifies the key to look for in the map. The key must be of the same data type as the

374 ni.com
Functions

existing keys in the map.

• default value —

default value specifies the value to return in value if the specified key does not exist in the map.
This input must be of the same data type as the existing values in the map.

• key not found? —

key not found? returns TRUE if map does not include an entry with the specified key. Otherwise,
key not found? returns FALSE .

This output exists on both the left and right border nodes. The two key not found? outputs
return the same value.

• value —

value returns the value of the entry with the associated key if key not found? is FALSE. If key not
found? is TRUE, this output returns the value in default value.

• action —

action specifies the operation to perform on the map based on the TRUE or FALSE value of key
not found?. This input assumes the value 0 if unwired.

Delete Entry—If key not found? is FALSE, this node deletes the entry with the specified key
2
from the map. If key not found? is TRUE, this node does nothing.
Modify Entry only if found (default)—If key not found? is FALSE, this node replaces the existing
0
associated value with the new value. If key not found? is TRUE, this node does nothing.
Add or Modify Entry—If key not found? is FALSE, this node replaces the existing associated
1 value with the new value. If key not found? is TRUE, this node adds the new key and the
associated value to the map.

• value —

value specifies the new value of the entry with the associated key.

• map —

map returns the resulting map.

• key —

© National Instruments 375


Functions

key returns the same value as the key input on the left side of the border node.

• key not found? —

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Word


Counting.vi
• labview\examples\Design Patterns\Registration Map\
Registration Map Usage.lvproj

Flat Sequence Structure

Consists of one or more subdiagrams, or frames, that execute sequentially. Use the
Flat Sequence structure to ensure that a subdiagram executes before or after another
subdiagram. Data flow for the Flat Sequence structure differs from data flow for other
structures. Frames in a Flat Sequence structure execute from left to right and when all
data values wired to a frame are available. The data leaves each frame as the frame
finishes executing. This means the input of one frame can depend on the output of
another frame.

Unlike in the Stacked Sequence structure, you do not need to use sequence locals to
pass data from frame to frame in the Flat Sequence structure. Since the Flat Sequence
structure displays each frame on the block diagram, you can wire from frame to frame
without using sequence locals and without hiding code.

When you add or delete frames in a Flat Sequence structure, the structure resizes
automatically.

You cannot drag tunnels across the frames of a Flat Sequence structure.

To avoid overusing Flat Sequence structures, attempt to control the data flow of your
VI by establishing data dependency or using flow-through parameters.

(Real-Time, Windows) To convert a Flat Sequence structure to a Timed Sequence

376 ni.com
Functions

structure, right-click the Flat Sequence structure and select Replace with Timed
Sequence from the shortcut menu.

Stacked Sequence Structure

A Stacked Sequence structure consists of one or more subdiagrams, or frames, that


execute sequentially. Right-click the structure border to add and delete frames or to
create sequence locals to pass data between frames. Use the Stacked Sequence
structure to ensure a subdiagram executes before or after another subdiagram.

To create a Stacked Sequence structure, place a Flat Sequence structure on the block
diagram, right-click the Flat Sequence structure, and select Replace with Stacked
Sequence.

To scroll through the available subdiagrams, click the decrement and increment
arrows in the selector label. You can add, duplicate, rearrange, or delete the
subdiagrams. You can use a sequence local terminal to pass data from one frame to
any subsequent frame.

Use the Stacked Sequence structure if you want to conserve space on the block
diagram. Use the Flat Sequence structure to avoid using sequence locals and to better
document the block diagram. To convert the Stacked Sequence structure to a Flat
Sequence structure, right-click the Stacked Sequence structure and select
Replace»Replace with Flat Sequence from the shortcut menu.

To convert the Stacked Sequence structure to a Case structure, right-click the Stacked
Sequence structure and select Replace»Replace with Case Structure from the
shortcut menu.

© National Instruments 377


Functions

The Stacked Sequence structure does not start to execute until all data wired to the
structure arrive. The data wired from each frame leave only when all the frames
complete execution.

To avoid overusing Stacked Sequence structures, attempt to control the data flow of
the VI by establishing data dependency or using flow-through parameters.

Formula Node

Evaluates mathematical formulas and expressions similar to C on the block diagram.


The following built-in functions are allowed in formulas: abs, acos, acosh, asin, asinh,
atan, atan2, atanh, ceil, cos, cosh, cot, csc, exp, expm1, floor, getexp, getman, int, intrz,
ln, lnp1, log, log2, max, min, mod, pow, rand, rem, sec, sign, sin, sinc, sinh, sizeOfDim,
sqrt, tan, tanh. There are some differences between the parser in the Mathematics VIs
and the Formula Node.

Refer to Creating Formula Nodes and Formula Node Syntax for more information
about the Formula Node and the Formula Node syntax. Also, keep in mind the allowed
operators in the Formula Node.

Formula Nodes have the following restrictions:

• Formula Nodes accept only the period (.) as a decimal separator. The nodes do
not recognize localized decimal separators.
• Formula Nodes accept only pi as a constant. The constant is case-sensitive.
• You cannot add Formula Nodes to a VI on which you enable inlining.

Diagram Disable Structure

Has one or more subdiagrams, or cases, of which only the Enabled subdiagram
executes. Use the Diagram Disable structure to disable a section of the block diagram.

Place a Diagram Disable structure around the code you want to disable. In the Enabled

378 ni.com
Functions

subdiagram, include any code that you want to enable in place of the code in the
Disabled subdiagram.

After you create a Diagram Disable structure, you can add, duplicate, rearrange, or
delete the subdiagrams. To scroll through the available subdiagrams, click the
decrement and increment arrows in the selector label. You also can remove the
structure without deleting objects in the structure.

The Diagram Disable structure allows you to disable a section of a block diagram. To
disable specific sections of code on the block diagram based on some user-defined
condition, use the Conditional Disable structure. To disable specific sections of code
on the block diagram based on compilation results, use the Type Specialization
structure.

To switch to a Conditional Disable or Type Specialization structure, right-click the


border of the Diagram Disable structure and select Replace with Conditional Disable
Structure or Replace with Type Specialization Structurefrom the shortcut menu.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Structures\Disable Structures\Diagram
Disable Structure.vi

Conditional Disable Structure

Has one or more subdiagrams, exactly one of which LabVIEW uses for the duration of
execution, depending on the configuration of the conditions of the subdiagram. Use
this structure when you want to disable specific sections of code on the block diagram
based on some user-defined condition. Right-click the structure border to add or
delete a subdiagram. When you add a subdiagram or right-click the structure border
and select Edit Condition For This Subdiagram from the shortcut menu, you can

© National Instruments 379


Functions

configure conditions in the Configure Condition dialog box.

You can configure conditions using predefined symbols or custom symbols.

After you create a Conditional Disable structure, you can add, duplicate, rearrange, or
delete the subdiagrams. To scroll through the available subdiagrams, click the
decrement and increment arrows in the selector label. You also can remove the
structure without deleting objects in the structure. If multiple subdiagrams have
conditions that are satisfied, only the first subdiagram will be enabled. If necessary,
you can reorder the subdiagrams so that the desired subdiagram executes.

The Conditional Disable structure allows you to disable specific sections of code on
the block diagram based on some user-defined condition. To disable specific sections
of code on the block diagram based on compilation results, use the Type
Specialization structure. To disable a section of a block diagram, use the Diagram
Disable structure.

To switch to a Type Specialization or Diagram Disable structure, right-click the border


of the Conditional Disable structure and select Replace with Type Specialization
Structure or Replace with Diagram Disable Structure from the shortcut menu.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Structures\Disable Structures\
Conditional Disable Structure.vi

Type Specialization Structure

Has one or more subdiagrams, exactly one of which LabVIEW compiles and executes,
depending on the order and the compilation result of the subdiagram. LabVIEW

380 ni.com
Functions

declines subdiagrams in order if they have syntax errors. LabVIEW accepts the first
subdiagram that does not have syntax errors and ignores the remaining subdiagrams.
If all subdiagrams have syntax errors, this structure accepts the last subdiagram.
Syntax errors are errors within the structure, such as broken wires, not errors caused
by subVIs or other dependencies. Use this structure to customize sections of code in a
malleable VI (.vim) for specific data types. You also can use this structure in
conjunction with the Assert Type VIs and functions to force a malleable VI to accept
only a subset of the acceptable data types or to decline specific data types.

After you create a Type Specialization structure, you can add, duplicate, rearrange, or
delete the subdiagrams. To scroll through the available subdiagrams, click the
decrement and increment arrows in the selector label. You also can remove the
structure without deleting objects in the structure.

The Type Specialization structure allows you to disable specific sections of code on the
block diagram based on compilation results. To disable specific sections of code on
the block diagram based on some user-defined condition, use the Conditional Disable
structure. To disable a section of a block diagram, use the Diagram Disable structure.

To switch to a Conditional Disable or Diagram Disable structure, right-click the border


of the Type Specialization structure and select Replace with Conditional Disable
Structure or Replace with Diagram Disable Structure from the shortcut menu.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Type Specialization


Structure\Malleable VIs - Type Specialization
Structure.lvproj

© National Instruments 381


Functions

Shared Variable

Represents a shared variable on the block diagram. To bind a Shared Variable node to
a shared variable from the active project, add a Shared Variable node to the block
diagram and double-click or right-click the node and select Select Variable>>Browse
from the shortcut menu to display the Browse for Variable dialog box. You also can
drag a shared variable from the Project Explorer window onto the block diagram of a VI
in the same project to create a Shared Variable node.

Note The behavior of the Shared Variable node differs when it is bound to a
physical I/O channel. Refer to the Using I/O Variables topic for information
about I/O variables.

Inputs/Outputs
• ?—

Variable specifies the value to write to the Shared Variable node. You must wire a value to this
input when the Shared Variable node is configured to write data, or the VI will be broken. This
input is available only when the Shared Variable node is configured to write data.

• ms timeout (0) —

ms timeout specifies a timeout period in milliseconds for a Shared Variable node configured to
read data. The shared variable waits the specified amount of time for updated data, and the
timed out? indicator returns whether the shared variable received updated data in the specified
time period or timed out. Updated data can represent a new value or an existing value that
simply confirms a valid connection with the shared variable in the active project. To add a ms
timeout input to the Shared Variable node, right-click the Shared Variable node and select Show
Timeout from the shortcut menu. You only can enable a timeout period for Shared Variable
nodes configured to read data. You cannot enable a timeout period for nodes that access I/O
variables locally.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

382 ni.com
Functions

• ?—

Variable specifies the current value of the shared variable that the Shared Variable node
represents. This output is available only when the Shared Variable node is configured to read
data. If the Shared Variable node times out, Variable returns the value that the node last read. If
the node times out before reading any data or if the type of data is incompatible, data returns a
value of 0, empty, or an equivalent value.

• timed out? —

timed out? displays whether a Shared Variable node read new data within the specified timeout
period or timed out. To add a timed out? output to the Shared Variable node, right-click the
Shared Variable node and select Show Timeout from the shortcut menu. You only can enable a
timeout period for Shared Variable nodes configured to read data. You cannot enable a timeout
period for nodes that access I/O variables locally.

If the timeout expires, the Shared Variable node returns the last value written to the variable and
does not return an error.
• timestamp —

timestamp displays the timestamp data for the shared variable. To add a timestamp output to
the Shared Variable node for a single-process shared variable or an I/O variable, you must first
place a checkmark in the Enable timestamp checkbox on the Variable page of the Shared
Variable Properties dialog box, and then right-click the Shared Variable node and select Show
Timestamp from the shortcut menu. You can use this output only with shared variable nodes
that are configured to read data.

• error out —

error out contains error information. This output provides standard error out functionality.

When you drag a shared variable from the Project Explorer window to the block
diagram or place a Shared Variable node on the block diagram, LabVIEW configures
the Shared Variable node to read data. To configure the Shared Variable node to write
data, right-click the Shared Variable node and select Change to Write from the
shortcut menu.

Note You can create, configure, and host shared variables only on Windows,
RT targets, and certain PDA targets. You can use the DataSocket VI and
functions to read or write shared variables from other platforms.

© National Instruments 383


Functions

To specify how a Shared Variable node connects to a shared variable, you can set the
node to absolute or target-relative. An absolute Shared Variable node always connects
to the shared variable on the target on which you created the shared variable. A target-
relative Shared Variable node always connects to the shared variable on the target on
which you run the VI that contains the Shared Variable node. To change an absolute
Shared Variable node to target-relative, right-click the Shared Variable node and select
Reference Mode»Target Relative from the shortcut menu. To change a target-relative
Shared Variable node to absolute, right-click the Shared Variable node and select
Reference Mode»Absolute from the shortcut menu.

Note

Opening a VI containing a Shared Variable node in a project where the Shared


Variable node cannot find its associated shared variable in the Project
Explorer window causes the Shared Variable node to break. Any front panel
controls associated with the missing shared variable also break.

(Windows) This behavior is specific to Windows and only occurs when you
open the VI in a project. If you open the VI in the main application instance,
you do not receive notification of missing shared variables.

A network-published Shared Variable node on a VI uses an .aliases file to determine


the IP address of the computing device in the project where the Shared Variable is
deployed. When you run a VI in a LabVIEW project, the VI finds the project's .aliases
file and uses that to resolve aliases. The project keeps entries for each computing
device in the project in the .aliases file, and updates the IP addresses when they
change. When the VI runs in the main application instance, the VI uses the
LabVIEW.aliases file in the same directory as LabVIEW.exe to find aliases. This
file does not update automatically like the project .aliases file. When building an
application that uses shared variables, ensure that the build specification includes the
.aliases file.

You must add the IP address to the .aliases file. If the VI fails to find the alias, the
Shared Variable node uses the last known IP address. If the shared variable is no
longer deployed at the last known IP address, the Shared Variable node will return an
error.

384 ni.com
Functions

If you publish a shared variable with less than 8 kilobytes of data, it can take up to 10
milliseconds for LabVIEW to send that data over the network. The Flush Shared
Variable Data VI allows you to flush the buffer immediately and eliminate this delay.

Note You can right-click a Shared Variable node and select Replace with
Programmatic Access from the shortcut menu to switch to programmatic
access. By using programmatic shared variable access, you can create clean,
scalable block diagrams.

Local Variable

Use local variables to read or write to one of the controls or indicators on the front
panel of a VI.

When you create a local variable, a local variable icon for the object appears on the
block diagram. Writing to a local variable is similar to passing data to any other
terminal. However, you can write to a local variable even if it is a control or read from a
local variable even if it is an indicator. In effect, with a local variable, you can access a
front panel object as both an input and an output.

Inputs/Outputs
• —

Global Variable

Use global variables to access and pass data among several VIs.

When you create a global variable, LabVIEW automatically creates a special global VI,
which has a front panel but no block diagram.

© National Instruments 385


Functions

Inputs/Outputs
• —

Decorations

Use the decorations located on the Decorations palette to group or separate objects
on a block diagram with boxes, lines, or arrows. These objects are for decoration only
and do not modify data.

You also can use decorations on the front panel.

Feedback Node

Stores data from one VI execution or loop iteration to the next.

A Feedback Node is analogous to a z-1 block in feedback control theory and digital
signal processing. You can change the appearance of the Feedback Node to look like
that of a z-1 block by right-clicking the Feedback Node and selecting Z-Transform View
from the shortcut menu. Changing the appearance to z-transform view, shown as
follows, changes only the cosmetic appearance of the Feedback Node.

The Feedback Node uses the value you wire to the initializer terminal as the initial
value for the first block diagram execution or loop iteration. If you do not wire a value
to the initializer terminal, the Feedback Node uses the default value for the data type.
The Feedback Node then stores the previous execution or iteration result.

You can enable or disable the feedback loop using the enable terminal. If the enable
terminal is set to TRUE, the Feedback Node runs as you configure it to run in the
Properties dialog box or from the shortcut menu of the node. If the enable terminal is
set to FALSE, the Feedback Node ignores the input value and returns the value from

386 ni.com
Functions

the last execution or iteration when the enable terminal was TRUE. The Feedback
Node continues to return this value until the execution or iteration after the enable
terminal changes to TRUE.

By default, the Feedback Node stores data from only the previous execution or
iteration. However, you can configure a Feedback Node to store n samples of data by
delaying the output of the node for multiple executions or iterations. If you increase
Delay to more than one execution or iteration, the Feedback Node outputs only the
initializer value until the delay you specify is complete. The Feedback Node then
begins to output the stored values in subsequent order. The number on the node
represents the number of delays you specify.

Note When you set Delay to two or more executions or iterations, you can
wire an array to the initializer terminal to initialize each delay element to an
arbitrary value.

This node automatically appears when you wire the output of a subVI, function, or
group of subVIs or functions to the input of that same VI, function, or group. In loops,
you can right-click the Feedback Node and select Replace with Shift Register from the
shortcut menu to replace the Feedback Node with shift registers. You also can replace
shift registers with a Feedback Node.

Inputs/Outputs
• —

• —

• —

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 387


Functions

• labview\examples\Structures\Feedback Node\Feedback Node -


Building an Array.vi

Array
Use the Array functions to create and manipulate arrays.

Palette
Description
Object
Array Size
Returns the number of elements in each dimension of array.
Function
Index
Returns the element or subarray of n-dimension array at index.
Array
Replace
Array Replaces an element or subarray in an array at the point you specify in index.
Subset
Insert Into
Inserts an element or subarray into n-dim array at the point you specify in index.
Array
Deletes an element or subarray from n-dim array of length elements starting at index.
Delete
Returns the edited array in array w/ subset deleted and the deleted element or
From Array
subarray in deleted portion.
Initialize Creates an n-dimensional array in which every element is initialized to the value of
Array element.
Build Array Concatenates multiple arrays or appends elements to an n-dimensional array.
Array
Returns a portion of array starting at index and containing length elements.
Subset
Array Max
Returns the maximum and minimum values found in array, along with the indexes for
& Min
each value.
Function
Reshape
Changes the dimensions of an array according to the values of dimension size 0..m-1.
Array
Sort 1D Returns a sorted version of array with the elements arranged in ascending order. If

388 ni.com
Functions

Palette
Description
Object
array is an array of clusters, the function sorts the elements by comparing the first
Array elements. If the first elements match, the function compares the second and
Function subsequent elements. The connector pane displays the default data types for this
polymorphic function.

Sort 2D Rearranges the rows or columns of a 2D array by sorting the elements in the specified
Array column or row in ascending order.

Shuffle 1D
Rearranges the elements of a 1D array in a pseudorandom order.
Array

Shuffle 2D
Rearranges the elements of a 2D array in a pseudorandom order.
Array

Reverse 1D
Array Reverses the order of the elements in array, where array is of any type.
Function
Search 1D Searches for an element in a 1D array starting at start index. Because the search is
Array linear, you need not sort the array before calling this function. LabVIEW stops
Function searching as soon as the element is found.
Split 1D
Divides array at index and returns the two portions with the element of index at the
Array
beginning of second subarray.
Function
Rotate 1D
Array Rotates the elements of array the number of places and in the direction indicated by n.
Function

Increment
Adds 1 to the specified elements of a 1D array. If the array is an array of timestamps,
Array
this VI increments the element by one second.
Element

Decrement
Subtracts 1 from the specified element of a 1D array. If the array is an array of
Array
timestamps, this VI decrements the element by one second.
Element

Interpolate Linearly interpolates a decimal y value from an array of numbers or points using a
1D Array fractional index or x value.

© National Instruments 389


Functions

Palette
Description
Object
Function
Interpolates points in a 1D array that represents a 2D non-descending graph. This
Threshold function compares threshold y to the values in array of numbers or points starting at
1D Array start index until it finds a pair of consecutive elements such that threshold y is greater
Function than or equal to the value of the first element and less than or equal to the value of the
second element.
Interleave
Interleaves corresponding elements from the input arrays into a single output array.
1D Arrays
Divides the elements of array into the output arrays, placing elements into the outputs
Decimate
successively. This function drops any elements that cause the output arrays to have
1D Array
different lengths.
Transpose
Rearranges the elements of 2D array such that 2D array[i,j] becomes transposed
2D Array
array[j,i].
Function
Array
Use this constant to supply a constant array value to the block diagram.
Constant
Array To Converts a 1D array to a cluster of elements of the same type as the array elements.
Cluster Double-click the function to open the Cluster Size dialog box and set the number of
Function elements in the cluster.
Cluster To
Converts a cluster of elements of the same data type to a 1D array of elements of the
Array
same data type.
Function

Converts an array to a matrix of elements of the same type as the array elements. Wire
Array To
data to the Real 2D Array input to determine the polymorphic instance to use or
Matrix
manually select the instance.

Converts a matrix of elements to an array of elements of the same data type. Wire data
Matrix To
to the Real Matrix input to determine the polymorphic instance to use or manually
Array
select the instance.

Remove
Removes duplicate elements from a 1D array. This VI preserves the original order of the
Duplicates
elements.
From 1D

390 ni.com
Functions

Palette
Description
Object
Array

Unsorted Use the Unsorted Array functions to manipulate arrays without sorting first.

Sorted Use the Sorted Array functions to manipulate sorted arrays while maintaining the
Array sorted order.

Use the Matrix functions to manipulate the elements, diagonals, and submatrices of a
Matrix matrix or 2D numeric array. Many of these functions complement existing array
operations but offer functionality for math algorithms based on matrices.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays

Array Size Function

Returns the number of elements in each dimension of array.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• array —

array can be an n-dimensional array of any type.

• size(s) —

© National Instruments 391


Functions

size(s) is a 32-bit integer if array is one-dimensional (1D).

If array is multidimensional, the returned value is a 1D array in which each element is a 32-bit
integer that represents the number of elements in the corresponding dimension of array. The
order of elements in the return array corresponds to row-major order. Thus, vol is the first index,
followed by page, row, and column. These names are index identifiers and have no other
meaning.

Index Array

Returns the element or subarray of n-dimension array at index.

When you wire an array to this function, the function resizes automatically to display
index inputs for each dimension in the array you wire to n-dimension array. You also
can add additional element or subarray terminals by resizing the function. The
connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• array —

n-dimension array can be an n-dimensional array of any type.

If n-dimension array is an empty array, element or subarray returns the default value of the
defined data type for the array.

• index —

index 0..n-1 specifies a number that refers to a location within the input array. LabVIEW
automatically provides an index input for each dimension of the array.

• element —

element or subarray has the same type as the elements of n-dimension array.

392 ni.com
Functions

You can disable indexing along a dimension by leaving the corresponding index input
unwired, unless you are indexing a 1D array. By default, the first dimension has
indexing enabled, with the others disabled. If disabled, the input terminal is an
outlined black rectangle. If enabled, it is filled. You can wire a constant or control to
the index inputs that you want enabled.

For example, if you want to index a row in a 2D array, the first index input is enabled
and the second index input is disabled. If you want to index that same 2D array also by
column, you can resize the function to show another set of input terminals. This next
set of inputs has its own corresponding subarray output. By default, if you do not wire
any index input terminals, the first subarray indexes row 0, the second subarray
indexes row 1, and so on.

Behavior for Out of Range Values

If the index is less than zero or greater than the number of dimensions in array, this
function returns the default value of the defined data type for the array.

Which Index Refers to Which Dimension?

Array functions in LabVIEW access array data in row-major order. In a 2D array, row is
the first, major index. Column is the last, minor index. In bigger multidimensional
arrays, column remains the last index, and this function adds the more major indexes
to the front. Thus, vol is the first index, followed by page, row, and column. These
names are index identifiers and have no other meaning.

Unwired Index Inputs

Unwired index inputs allow you to retrieve a subarray of the array rather than a single
element. For example, to retrieve column 1 of a 2D array, specify 1 in the column index
and leave the row index unwired.

If you leave the index input unwired for a 1D array, the Index Array function returns the
first element of the array.

How Does the Index Relate to Multiple Outputs?

If you expand the node to show more than one element or subarray output, LabVIEW

© National Instruments 393


Functions

provides a set of index inputs for each output. The values you wire to a set of index
inputs determine the value of the corresponding output. However, if you do not wire
values to a set of index inputs, the corresponding element or subarray output returns
the element or subarray that follows the previous element or subarray output in the
original array. Refer to the Examples section for an illustration of this relationship.

Examples of Different Input Configurations

The following image and table illustrate this function's behavior for a variety of input
values:

Output Value Comments


element,
all indexes 1 ---
wired
subarray, [1, 1, Without a value for the column dimension, Index Array returns the entire row
row wired 1] specified by the row input.
subarray, This output has no values specified for its corresponding row and column
[2, 2,
indexes inputs. Therefore, the function returns the subarray that immediately follows
2]
unwired the previous output.
subarray,
[0, 1, Without a value for the row dimension, Index Array returns the entire column
column
2] specified by the column input.
wired

394 ni.com
Functions

Replace Array Subset

Replaces an element or subarray in an array at the point you specify in index.

When you wire an array to this function, the function resizes automatically to display
index inputs for each dimension in the array you wired. The connector pane displays
the default data types for this polymorphic function.

Inputs/Outputs
• array —

n-dimension array is the array in which you want to replace an element(s), row(s), column(s), or
page(s). This input can be an n-dimension array of any type.

• index —

index 0..n-1 specifies the element, row, column, or page you want to replace in the array. If you
do not wire this input, the dimensions of the new element/subarray input determines the
number of elements of n-dimension array, starting with element 0, this function replaces. If you
specify an index without wiring the following indexes, this function continues from the last index
you specify.

For example, if you do not wire this input and n-dimension array consists of three elements, and
new element/subarray consists of two elements, this function replaces only the first two
elements (0 and 1) of n-dimension array. If you specify 1 for the first index without wiring other
indexes and n-dimension array consists of three elements, and new element/subarray consists
of two elements, this function replaces only the second and the third element (1 and 2) of n-
dimension array.
• new element/subarray —

new element/subarray is the array or element that replaces an element, row, column, or page in
the array specified in n-dimension array.

Note The base data type of the new element or subarray must be the same type as

© National Instruments 395


Functions

the input array.

• output array —

output array is the array this function returns with the replaced element(s), row(s), column(s), or
page(s).

Resize this function to replace multiple elements or array subsets at one time. Replace
Array Subset does not affect the original input array. This function crops any subarray
that is too large to fit as a column, row, or page in the input array. If any index is
negative or larger than the corresponding dimension in n-dimension array the
function has no effect.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Replace Array Elements.vi

Insert Into Array

Inserts an element or subarray into n-dim array at the point you specify in index.

When you wire an array to this function, the function resizes automatically to display
index inputs for each dimension in the array. If you do not wire any index inputs, the
function appends the new element or subarray to the end of the n-dim array. If the
index input is larger than the array size, the function does not insert anything into the
input array.

Inputs/Outputs
• array —

396 ni.com
Functions

n-dim array is the array in which you want to insert an element, row, column, page, and so on.
This input can be an n-dimension array of any type.

• index —

index 0..n-1 specifies the point in the array at which you want to insert the element, row,
column, page, and so on. You can wire only one index input.

For example, to insert a 1D array as the fourth row of a 2D array, wire 3 to the first index input,
and the second index input becomes disabled. To insert the array as the fourth column of the 2D
array, wire 3 to the second index input, and the first index input becomes disabled.
• new element/subarray —

n or n-1 dim array is the element, row, column, or page you want to insert into the array
specified in n-dim array.

• output array —

output array is the array this function returns with the inserted element(s), row(s), column(s), or
page(s).

Note The base data type of the new element or array must be the same type
as the input array. For example, if the input array contains Boolean control
references, then the new element must be a Boolean control reference. Use
the To More Generic Class function when you create the input array if you
want to insert more generic elements into the array.

This function resizes the array along only one dimension. Therefore, you can wire only
one index input. The index you wire determines the dimension along which you can
insert. For example, to insert row(s), wire the row index, or to insert column(s), wire
the column index.

The array you wire to n or n-1 dim array must be the same dimension or a dimension
less than the one you wired to n-dim array. For example, you cannot insert a single
element into a 2D array, and you cannot insert a single row (a 1D array) into a 3D array.
You can, however, insert a 2D array that has a single row into a 3D array. LabVIEW pads
the resulting array as necessary.

© National Instruments 397


Functions

Delete From Array

Deletes an element or subarray from n-dim array of length elements starting at index.
Returns the edited array in array w/ subset deleted and the deleted element or
subarray in deleted portion.

When you wire an array to this function, the function resizes automatically to display
index inputs for each dimension in the array.

Inputs/Outputs
• array —

n-dim array is the array from which you want to delete element(s), row(s), column(s), page(s),
and so on. This input can be an n-dimension array of any type.

• length —

length determines how many elements, rows, columns, or pages to delete. The default length is
one element.

• index —

index 0..n-1 specifies what you want to delete from the array, such as an element, row, column,
or page.

Array functions in LabVIEW access array data in row-major order. In a 2D array, row is the first,
major index. Column is the last, minor index. In bigger multidimensional arrays, column remains
the last index and the more major indexes are added to the front. Thus, vol is the first index,
followed by page, row, and column. These names are index identifiers and have no other
meaning.

The default is the index of the last element in the array. You can wire only one index input.

• array w/ subset deleted —

array w/ subset deleted is the array returned with the deleted element(s), row(s), column(s), or

398 ni.com
Functions

page(s).

• deleted portion —

deleted portion is the deleted element or array.

If you wire a value to length, deleted portion is an array of the same number of dimensions as n-
dim array containing all the elements deleted from n-dim array. The outer dimension size of
deleted portion is the value of length, and the inner dimension size(s) match that of n-dim
array. For example, if you wire a 3D array of dimensions 10x4x6 to n-dim array and a value of 2
to length, and do not wire values to the index inputs, deleted portion is a 3D array of
dimensions 2x4x6 containing the last 2 pages from n-dim array.

If you wire a value to length and a negative value to the index, deleted portion is an array with
an outer dimension size of the value of length minus the absolute value of the index. If the index
is a negative value and the value of length is smaller than the absolute value of the index,
deleted portion is empty.

If you do not wire a value to length, deleted portion is an array of one less dimension than n-
dim array containing the portion of the array deleted from n-dim array. For example, if you
wired a 2D array of dimensions 8x5 to n-dim array and do not wire a value to length, and wire 3
to index 0 (row), deleted portion is a 1D array containing all elements from row 3 of n-dim array.

This function reduces the array in one dimension only, therefore, you can wire only
one index input. For example, to delete a row in a 2D array, wire only the row index. To
delete a column, wire only the column index. You can delete multiple consecutive
subarrays at once by wiring length.

Initialize Array

Creates an n-dimensional array in which every element is initialized to the value of


element.

Use the Positioning tool to resize the function and increase the number of dimensions
(element, row, column, page, and so on) of the output array. The connector pane
displays the default data types for this polymorphic function.

© National Instruments 399


Functions

Inputs/Outputs
• element —

element is the value used to initialize all elements of initialized array. element can be any scalar
type.

• dimension size —

dimension size 0..n-1 must be a number. The function creates an empty array if any dimension
size is less than or equal to 0. You must have n dimension size terminals for n-dimensions.

• initialized array —

initialized array is an array of the same type as the type you wire to element.

Build Array

Concatenates multiple arrays or appends elements to an n-dimensional array.

You also can use the Replace Array Subset function to modify an existing array.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• element —

array or element can be any n-dimensional array or scalar element.

All inputs must be either elements and 1D arrays or n-dimensional and (n-1)-dimensional arrays.

400 ni.com
Functions

All inputs must have the same base type.

• appended array —

appended array is the resulting array.

When you place the function on the block diagram, it has only one input available. Add
inputs to the node by right-clicking an input and selecting Add Input from the shortcut
menu or by resizing the node.

If you wire control references of different classes to this function, this function
typecasts the references to a more generic class that is the lowest common class in the
inheritance hierarchy. This function then returns appended array with that class.

The Build Array function operates in one of two modes depending on whether you
select Concatenate Inputs from the shortcut menu. If you select Concatenate Inputs,
the function appends all inputs in order, forming an output array of the same
dimensionality as the array input wired.

If you do not select Concatenate Inputs, the function builds an output array of one
dimension higher than the dimension of the inputs. For example, if you wire 1D array
input to a Build Array function, the output is a 2D array, even if the 1D array is empty.
The inputs must all be the same dimensionality. The function appends each input in
order, forming a subarray, element, row, or page, of the output array. Inputs are
padded, as necessary, to match the size of the longest input.

For example, if you wire two 1D arrays, {1, 2} and {3, 4, 5} to Build Array, and select
Concatenate Inputs from the shortcut menu, the output is the 1D array {1, 2, 3, 4, 5}. If
you wire the same two arrays to Build Array, and do not select Concatenate Inputs
from the shortcut menu, the output is a 2D array containing {{1, 2, 0}, {3, 4, 5}}, where
the first input is padded to match the length of the second input.

If the inputs are all arrays of the same dimensionality, right-click the function to
remove the checkmark next to or select the Concatenate Inputs shortcut menu item. If
the inputs do not have the same dimensionality, Concatenate Inputs is automatically
selected and cannot be deselected. If all the inputs are scalar elements, Concatenate
Inputs is automatically deselected and cannot be selected, and the output is a 1D

© National Instruments 401


Functions

array containing the elements in order.

When you select Concatenate Inputs from the shortcut menu, the glyphs in the Build
Array icon change to distinguish between the two input types. Inputs with the same
dimensionality as the output show an array glyph, while inputs with a dimensionality
that is one less than the output show an element glyph.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Build Array.vi

Array Subset

Returns a portion of array starting at index and containing length elements.

Inputs/Outputs
• array —

array can be an n-dimensional array of any type.

• index —

index specifies the first element, row, column, or page to include in the portion of array you
want to return.

If index is less than 0, the function treats it as 0. If index is greater than or equal to the array size,
the function returns an empty array.

• length —

length specifies how many elements, rows, columns, or pages to include in the portion of array

402 ni.com
Functions

you want to return. If index plus length is larger than the size of the array, the function returns
only as much data as is available.

The default is the length from index to the end of array. If length is less than 0, the function
treats it as 0.

• subarray —

subarray is of the same type as array.

When you wire an array to this function, the function resizes automatically to display
index and length inputs for each dimension in the array. If you wire a 1D array to the
function, the function displays the index inputs for an element. If you wire a 2D array
to the function, the function displays the index inputs for a row and column,
respectively. If you wire a 3D through nD array to the function, the function displays
the index inputs for a page.

The connector pane displays the default data types for this polymorphic function.

You can use the Index Array function to modify the shape of the subarray. For example,
if the input to an Index Array function is a 2D array and you wire only the row input,
you extract a complete 1D row of the array.

Array Max & Min Function

Returns the maximum and minimum values found in array, along with the indexes for
each value.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• array —

© National Instruments 403


Functions

array can be an n-dimensional array of any type.

• max value —

max value is of the same data type and structure as the elements in array.

• max index(es) —

max index(es) is the index for the first max value.

If array is multidimensional, max index(es) is an array whose elements are the indexes for the
first maximum value in array.

• min value —

min value is of the same data type and structure as the elements in array.

• min index(es) —

min index(es) is the index for the first min value.

If array is multidimensional, min index(es) is an array whose elements are the indexes for the
first minimum value in array.

The function compares each data type according to the rules for Array Comparison.

If a numeric array has one dimension, the max index and min index outputs are scalar
integers. If a numeric array has more than one dimension, these outputs are 1D arrays
that contain the indexes of the maximum and minimum values.

If the input array is empty, max index and min index are –1.

Reshape Array

Changes the dimensions of an array according to the values of dimension size 0..m-1.

This function reads the array data in memory from left to right, row by row and
populates the reshaped array the same way. For example, if you pass a 2D array of 8
elements, 2 columns of {0,1,2, 3}, to this function with two dimensions defined with
sizes of 2 and 4, respectively, the function returns an array containing {{0,0,1,1}, {2,2, 3,

404 ni.com
Functions

3}}. The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• array —

n-dim array can be an n-dimensional array of any type.

• dimension size —

dimension size 0..m-1 specifies the dimensions of m-dim array and must be a numeric.

The function creates an empty array if any dimension size is 0. You must have m dimension size
terminals for m-dimensions.
• output array —

m-dim array If the product of the dimension sizes is greater than the number of elements in the
input array, the function pads the new array with the default of the data type of n-dim array.

If the product of the dimension sizes is less than the number of elements in the input array, the
function truncates the array.

This function adjusts the array data in memory according to the reshaped array
dimensions. This function pads or truncates the data if necessary. For example, if you
pass a 1D array with 9 elements {0, 1, 2, 3, 4, 5, 6, 7, 8} to this function with two
dimensions defined with sizes of 2 and 3, respectively, the function returns a 2D array
containing {{0, 1, 2}, {3, 4, 5}}. The function truncates the last three input elements
because the output array has room for only six values.

Resize this function to increase the number of dimension size parameters. m-dim
array has one dimension for each dimension size input. For example, you can use this
function to change a 1D array into a 2D array or vice versa. You also can use it to
increase and decrease the size of a 1D array.

© National Instruments 405


Functions

Sort 1D Array Function

Returns a sorted version of array with the elements arranged in ascending order. If
array is an array of clusters, the function sorts the elements by comparing the first
elements. If the first elements match, the function compares the second and
subsequent elements. The connector pane displays the default data types for this
polymorphic function.

Note To customize the sort order use the Sort 1D Array Malleable VI.

Inputs/Outputs
• array —

unsorted array can be a 1D array of any type.

• sorted array —

sorted array is the output array.

Sort 2D Array

Rearranges the rows or columns of a 2D array by sorting the elements in the specified
column or row in ascending order.

This VI rearranges the elements in the specified column or row in ascending order by
comparing the elements using comparison rules for different data types.

406 ni.com
Functions

Inputs/Outputs
• 2D array —

2D array specifies the 2D array that you want to sort.

This input accepts an array of any data type except refnums.

• dimension to index (column) —

dimension to index specifies the dimension of the 2D array to sort by.

column (default)—Rearranges the rows by sorting the elements in the indexed column in
0
ascending order.
1 row—Rearranges the columns by sorting the elements in the indexed row in ascending order.

• index —

index specifies the index of the column or row with elements that you want to rearrange.

This input accepts a signed 32-bit integer or an array of signed 32-bit integers.

• sorted 2D array —

sorted 2D array returns a sorted version of the 2D array.

• index out of range? —

index out of range? returns TRUE if the indexed column or row, or any of the indexed columns or
rows does not exist in the 2D array. Otherwise, this output returns FALSE.

The example below demonstrates how this VI sorts the following 2D array if dimension
to index is column.

Alice 28 Female developer


Robert 31 Male Manager
David 29 Male Technician
Kate 29 Female Engineer

© National Instruments 407


Functions

If index is 1, this VI returns the following array.

Alice 28 Female developer


David 29 Male Technician
Kate 29 Female Engineer
Robert 31 Male Manager

Note If multiple rows have the same element for the indexed column, this VI
keeps the original order of rows.

If index is 3, this VI returns the following array.

Kate 29 Female Engineer


Robert 31 Male Manager
David 29 Male Technician
Alice 28 Female developer

Note For string elements, this VI rearranges the elements based on case-
sensitivity. In this example, the indexed column contains the following
elements:
developer
,
Manager
,
Technician
,
Engineer
. This VI rearranges this column to
Engineer
,
Manager
,

408 ni.com
Functions

Technician
,
developer
.

If index is {2, 0}, this VI returns the following array.

Alice 28 Female developer


Kate 29 Female Engineer
David 29 Male Technician
Robert 31 Male Manager

Note If index is an array, this VI rearranges the elements in the indexed


columns in order. In this example, this VI rearranges first the elements in
column 2 to be ascending, and then the elements in column 0.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Basics\Malleable VIs


Basics.lvproj

Shuffle 1D Array

Rearranges the elements of a 1D array in a pseudorandom order.

This VI uses a uniform shuffle so that every element has an equal chance of ending up
in any position of the array.

© National Instruments 409


Functions

Inputs/Outputs
• array —

array specifies the 1D array with elements that you want to shuffle. The array can be a 1D array
of any data type.

• shuffled array —

shuffled array returns a shuffled version of the 1D array.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Basics\Malleable VIs


Basics.lvproj

Shuffle 2D Array

Rearranges the elements of a 2D array in a pseudorandom order.

This VI uses a uniform shuffle so that every element has an equal chance of ending up
in any position of the array.

Inputs/Outputs
• array —

array specifies the 2D array with elements that you want to shuffle. The array can be a 2D array
of any data type.

• shuffled array —

shuffled array returns a shuffled version of the 2D array.

410 ni.com
Functions

Reverse 1D Array Function

Reverses the order of the elements in array, where array is of any type.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• array —

array is a one-dimensional array of any type.

• reversed array —

reversed array. If array has n elements, array[0] becomes reversed array[n-1], array[1] becomes
reversed array[n-2], and so on.

Search 1D Array Function

Searches for an element in a 1D array starting at start index. Because the search is
linear, you need not sort the array before calling this function. LabVIEW stops
searching as soon as the element is found.

Inputs/Outputs
• 1D array —

1D array can be a 1D array of any type.

• element —

© National Instruments 411


Functions

element is the value to search for in the array. element must be the same data type as the
elements in 1D array.

• start index (0) —

start index is the index that LabVIEW begins the search from. The default is 0.

• index of element —

index of element is the index where element is found.

If the function does not find element, index of element is –1.

You cannot use this function to retrieve the index of a value that is not an element of
the array. For example, if you have an array of two elements (0.0 and 1.0), this function
does not find the index of the value 0.5, as that value is not an element of the array.
Use the Threshold 1D Array to find a fractional index.

This function only finds a string if the element you specify matches an array element
exactly. For example, if you have an array of two elements (upper limit and
lower limit), this function does not find the index of the value limit, because
limit does not match an array element exactly. To search a string for any occurrence
of a regular expression, use the Match Regular Expression function.

Split 1D Array Function

Divides array at index and returns the two portions with the element of index at the
beginning of second subarray.

The connector pane displays the default data types.

Inputs/Outputs
• array —

412 ni.com
Functions

array can be a 1D array of any type.

• index —

index must be numeric. If index is negative or 0, first subarray is empty.

If index is equal to or greater than the size of array, second subarray is empty.
• first subarray —

first subarray contains array[0] through array[index-1].

• second subarray —

second subarray contains the remaining array elements not already contained in first subarray.

If the input array is empty, both output arrays are empty. This function does not
generate an error if you pass in an empty array.

Rotate 1D Array Function

Rotates the elements of array the number of places and in the direction indicated by n.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• n—

n must be a numeric data type.

The function coerces n to a 32-bit integer if you wire another representation to it.
• array —

array can be a 1D array of any type.

• array (last n elements first) —

© National Instruments 413


Functions

array (last n elements first) is the output array.

For example, if n is 1, the input array[0] becomes output array[1], input array[1] becomes output
array[2], and so on, and input array[m–1] becomes output array[0], where m is the number of
elements in the array. If n is –2, input array[0] becomes output array[m–2], input array[1]
becomes output array[m–1], and so on, and input array[m–1] becomes output array[m–3],
where m is the number of elements in the array.

Increment Array Element

Adds 1 to the specified elements of a 1D array. If the array is an array of timestamps,


this VI increments the element by one second.

Inputs/Outputs
• array in —

array in specifies the 1D array with the element that you want to increment.

This input accepts an array or an array of clusters of the following data types:
• Numbers
• Timestamps
• Analog Waveforms
• index —

index specifies the index of the element in the array that you want to increment.

This input accepts a signed 32-bit integer or an array of signed 32-bit integers.

• array out —

array out returns the 1D array with the specified element incremented.

Examples

Refer to the following example files included with LabVIEW.

414 ni.com
Functions

• labview\examples\Malleable VIs\Basics\Malleable VIs


Basics.lvproj

Decrement Array Element

Subtracts 1 from the specified element of a 1D array. If the array is an array of


timestamps, this VI decrements the element by one second.

Inputs/Outputs
• array in —

array in specifies the 1D array with the element that you want to decrement.

This input accepts an array or an array of clusters of the following data types:
• Numbers
• Timestamps
• Analog Waveforms
• index —

index specifies the index of the element in the array that you want to decrement.

This input accepts a signed 32-bit integer or an array of signed 32-bit integers.

• array out —

array out returns the 1D array with the specified element decremented.

Interpolate 1D Array Function

Linearly interpolates a decimal y value from an array of numbers or points using a


fractional index or x value.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 415


Functions

Inputs/Outputs
• array of numbers or points —

array of numbers or points can be an array of numbers or an array of points where each point is
a cluster of x and y coordinates. If this input is an array of points, the function uses the first
element in the cluster (x) to obtain a fractional index by linear interpolation. The function then
uses this fractional index to compute the output y value from the second cluster element (y).

• fractional index or x —

fractional index or x is the index or x-value at which the function should return a y-value.

For example, if array of numbers or points contains two double-precision, floating-point


numeric values, 5 and 7, and fractional index or x is set to 0.5, the function returns 6.0, which is
halfway between the values at elements 0 and 1.

If array of numbers or points contains an array of data point sets, the function returns the
linearly interpolated y value at the x-value corresponding to fractional index or x. For example,
if the array contains two points, (3,7) and (5,9), and fractional index or x is set to 3.5, the
function returns 7.5.

fractional index or x does not interpolate beyond the bounds of an array or data point set. For
example, if the parameter is set lower than the first element or x-value in an array, the function
returns the value of the first element or the y-value of the first data point. Similarly, if the
parameter is set too high, the function returns the value in the final element or the final y-value.
fractional index or x must be located directly on a point or between two points for the function
to work correctly.

• y value —

y value is the interpolated value of the element at the fractional index or the interpolated y-
value of the fractional data point, in array of numbers or points.

You can wire an array of numeric values or an array of data point sets to this function. If
you wire an array of numeric values, the function interprets fractional index or x as a
reference to the array elements. If you wire an array of data point sets, the function
interprets fractional index or x as a reference to the x-value elements within each data
point set.

416 ni.com
Functions

Note If you wire an array of data points to this function, the data points must
be sorted by increasing x-value.

Threshold 1D Array Function

Interpolates points in a 1D array that represents a 2D non-descending graph. This


function compares threshold y to the values in array of numbers or points starting at
start index until it finds a pair of consecutive elements such that threshold y is greater
than or equal to the value of the first element and less than or equal to the value of the
second element.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• array of numbers or points —

array of numbers or points can be an array of numbers or an array of points where each point is
a cluster of x- and y-coordinates.

If this input is an array of points, this function uses the second elements in the clusters, or the y-
coordinates, to obtain a fractional index that it then uses to interpolate the corresponding x
value.
• threshold y —

threshold y is the threshold value for the function. If threshold y is less than or equal to the
array value at start index, the function returns start index for fractional index or x.

If threshold y is greater than every value in the array, the function returns the index of the last
value. If the array is empty, the function returns NaN.
• start index (0) —

start index must be a number. The default is 0, which means the function returns the result
calculated from the entire array, rather than a specified section of the array.

• fractional index or x —

© National Instruments 417


Functions

fractional index or x is the interpolated result LabVIEW calculates for the array of numbers or
points 1D input array.

For example, suppose array of numbers or points is an array of four numbers [4, 5, 5, 6], start
index is 0, and threshold y is 5. The fractional index or x is 1, corresponding to the index of the
first value of 5 the function finds. Suppose the array elements are 2.3, 5.2, 7.8, 7.9, 10.0, the start
index is 0, and the threshold y is 6.5. The output is 1.5 because 6.5 is halfway between 5.2 (index
1) and 7.8 (index 2). If threshold y is 7 for the same set of numbers, the output is 1.69. If
threshold y is 14.2, start index is 5, and the values in the array starting at index 5 are 9.1, 10.3,
12.9, and 15.5, threshold y falls between elements 7 and 8 because 14.2 is midway between 12.9
and 15.5. The value for fractional index or x is 7.5, that is, halfway between 7 and 8.

If the array input consists of an array of points where each point is a cluster of x- and y-
coordinates, the output is the interpolated x value corresponding to the interpolated position of
threshold y among the y-coordinates, rather than the fractional index of the array. If the
interpolated position of threshold y is midway between the y values at indexes 4 and 5 of the
array with x values of –2.5 and 0 respectively, the output is not an index value of 4.5 as it would
be for a numeric array, but rather an x value of –1.25. In other words, this function returns the
interpolated x value associated with the given y value if you graphed the points.

This function works the same for arrays of numbers as it does for arrays of points. If you have an
array of numbers, this function assumes the x-coordinates are the same as the indexes of the
array itself. In other words, this function assumes the points are uniformly spaced.

This function calculates the fractional distance between the first value and threshold y
and returns the fractional index at which threshold y would be placed within array of
numbers or points using linear interpolation.

Note Use this function only with arrays sorted in non-descending order.

This function does not recognize the index of a negative slope crossing, and it might
return incorrect data if threshold y is less than the value at start index. Use the
Threshold Detector VI for more advanced analysis of arrays.

Interleave 1D Arrays

Interleaves corresponding elements from the input arrays into a single output array.

418 ni.com
Functions

Inputs/Outputs
• array —

array 0..n-1 must be 1D. If the input array is not the same size, the number of elements in
interleaved array equals the number of elements in the smallest input array multiplied by the
number of input arrays.

• array —

• interleaved array —

interleaved array[0] contains array 0[0], interleaved array[1] contains array 1[0], interleaved
array[n-1] contains array n-1[0], interleaved array[n] contains array 0[1], and so on, where n is
the number of input terminals.

The following table shows how elements from the input arrays affect interleaved array.

array 0 array 1 array 2 interleaved array


[0, 3] [1, 4] [2, 5] [0, 1, 2, 3, 4, 5]
[0, 3, 5] [1] [2, 4] [0, 1, 2]

Decimate 1D Array

Divides the elements of array into the output arrays, placing elements into the outputs
successively. This function drops any elements that cause the output arrays to have
different lengths.

You also can add additional output terminals by resizing the function.

© National Instruments 419


Functions

Inputs/Outputs
• array —

array can be a 1D array of any type.

• decimated array —

elements 0, n, 2n, … is the first output array.

The function stores array[0] at index 0 of the first output array, array[1] is stored at index 0 of the
second output array, array[n-1] at index 0 of the last output array, array[n] at index 1 of the first
output array, and so on, where n is the number of output terminals for this function.

For example, assume the array has 16 elements and that you wire four output arrays. The first
output array receives elements 0, 4, 8, and 12. The second output array receives elements 1, 5, 9,
and 13. The third output array receives elements 2, 6, 10, and 14. The last output array receives
elements 3, 7, 11, and 15. This is the expected behavior.

If you remove one element from the input array there will only be 15 elements. The last
decimated array will only have 3 elements (3, 7, and 11) since element 15 was deleted. Since the
function will only return arrays of the same size, the other 3 decimated arrays will drop their last
element so that all of the arrays now contain 3 elements.

• decimated array —

elements 1, n+1, 2n+1, … is the second output array, and so on.

Transpose 2D Array Function

Rearranges the elements of 2D array such that 2D array[i,j] becomes transposed


array[j,i].

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• 2D array —

420 ni.com
Functions

2D array can be a 2D array of any type.

• transposed array —

transposed array is the output array.

Array Constant

Use this constant to supply a constant array value to the block diagram.

Define the type of the array constant by selecting any scalar constant from the
Functions palette and placing it inside the array constant. All elements of the array are
of this type. Use the >Operating tool to enter values for each array element. You cannot
change the value of the array constant while the VI runs.

Array To Cluster Function

Converts a 1D array to a cluster of elements of the same type as the array elements.
Double-click the function to open the Cluster Size dialog box and set the number of
elements in the cluster.

The default is nine. The maximum cluster size for this function is 256.

Use this function when you want to display elements of the same type in a front panel
cluster indicator but want to manipulate the elements on the block diagram by their
index values.

Inputs/Outputs
• array —

© National Instruments 421


Functions

array is a one-dimensional array of any type.

• cluster —

Each element in cluster is the same as the corresponding element in array.

The cluster order matches the order of the elements in the array.

• —

• —

• —

• —

• —

• —

• —

• —

• —

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Array to Cluster.vi

Cluster To Array Function

Converts a cluster of elements of the same data type to a 1D array of elements of the
same data type.

422 ni.com
Functions

Inputs/Outputs
• cluster —

The cluster components cannot be arrays.

• —

• array —

The elements in array are of the same type as the elements in cluster.

The order of the elements in array is the same as the cluster order of the elements.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Array to Cluster.vi

Array To Matrix

Converts an array to a matrix of elements of the same type as the array elements. Wire
data to the Real 2D Array input to determine the polymorphic instance to use or
manually select the instance.

• Array To Matrix - RA2 VI


• Array To Matrix - RA VI
• Array To Matrix - CA2 VI
• Array To Matrix - CA VI

If the array elements are not real or complex double-precision floating-point numbers,

© National Instruments 423


Functions

LabVIEW converts the array elements to the closest data type.

LabVIEW stores the elements of 1D arrays in the first column of the matrix.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi
• labview\examples\Mathematics\Linear Algebra\Matrix to a
Power.vi

Array To Matrix - RA2 VI

Converts an array to a matrix of elements of the same type as the array elements. Wire
data to the Real 2D Array input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Real 2D Array —

Real 2D Array specifies a two-dimensional array.

• Real Matrix —

The elements in Real Matrix are of the same type as the elements in Real 2D Array. The order of
the elements in Real Matrix is the same as the Real 2D Array order of the elements.

If the array elements are not real or complex double-precision floating-point numbers,
LabVIEW converts the array elements to the closest data type.

LabVIEW stores the elements of 1D arrays in the first column of the matrix.

424 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi
• labview\examples\Mathematics\Linear Algebra\Matrix to a
Power.vi

Array To Matrix - RA VI

Converts an array to a matrix of elements of the same type as the array elements. Wire
data to the Real 2D Array input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Real 1D Array —

Real 1D Array specifies a one-dimensional array.

• Real Matrix (Column Vector) —

The elements in Real Matrix (Column Vector) are of the same type as the elements in Real 1D
Array. The order of the elements in Real Matrix (Column Vector) is the same as the Real 1D
Array order of the elements.

If the array elements are not real or complex double-precision floating-point numbers,
LabVIEW converts the array elements to the closest data type.

LabVIEW stores the elements of 1D arrays in the first column of the matrix.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 425


Functions

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi
• labview\examples\Mathematics\Linear Algebra\Matrix to a
Power.vi

Array To Matrix - CA2 VI

Converts an array to a matrix of elements of the same type as the array elements. Wire
data to the Real 2D Array input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Complex 2D Array —

Complex 2D Array specifies a complex two-dimensional array.

• Complex Matrix —

The elements in Complex Matrix are of the same type as the elements in Complex 2D Array. The
order of the elements in Complex Matrix is the same as the Complex 2D Array order of the
elements.

If the array elements are not real or complex double-precision floating-point numbers,
LabVIEW converts the array elements to the closest data type.

LabVIEW stores the elements of 1D arrays in the first column of the matrix.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi
• labview\examples\Mathematics\Linear Algebra\Matrix to a

426 ni.com
Functions

Power.vi

Array To Matrix - CA VI

Converts an array to a matrix of elements of the same type as the array elements. Wire
data to the Real 2D Array input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Complex 1D Array —

Complex 1D Array specifies a complex one-dimensional array.

• Complex Matrix (Column Vector) —

The elements in Complex Matrix (Column Vector) are of the same type as the elements in
Complex 1D Array. The order of the elements in Complex Matrix (Column Vector) is the same as
the Complex 1D Array order of the elements.

If the array elements are not real or complex double-precision floating-point numbers,
LabVIEW converts the array elements to the closest data type.

LabVIEW stores the elements of 1D arrays in the first column of the matrix.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi
• labview\examples\Mathematics\Linear Algebra\Matrix to a
Power.vi

© National Instruments 427


Functions

Matrix To Array

Converts a matrix of elements to an array of elements of the same data type. Wire data
to the Real Matrix input to determine the polymorphic instance to use or manually
select the instance.

• Matrix To Array - RM VI
• Matrix To Array - CM VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi

Matrix To Array - RM VI

Converts a matrix of elements to an array of elements of the same data type. Wire data
to the Real Matrix input to determine the polymorphic instance to use or manually
select the instance.

Inputs/Outputs
• Real Matrix —

Real Matrix specifies a real matrix.

• Real 2D Array —

The elements in Real 2D Array are of the same type as the elements in Real Matrix. The order of
the elements in Real 2D Array is the same as the Real Matrix order of the elements.

428 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi

Matrix To Array - CM VI

Converts a matrix of elements to an array of elements of the same data type. Wire data
to the Real Matrix input to determine the polymorphic instance to use or manually
select the instance.

Inputs/Outputs
• Complex Matrix —

Complex Matrix specifies a complex matrix.

• Complex 2D Array —

The elements in Complex 2D Array are of the same type as the elements in Complex Matrix. The
order of the elements in Complex 2D Array is the same as the Complex Matrix order of the
elements.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Linear Algebra\Matrix
Fundamentals.vi

Remove Duplicates From 1D Array

Removes duplicate elements from a 1D array. This VI preserves the original order of the

© National Instruments 429


Functions

elements.

Inputs/Outputs
• array —

array specifies the input array. This input accepts a 1D array of any data type.

• array with duplicates removed —

array with duplicates removed returns an array with the duplicate elements removed from
array.

Unsorted

Use the Unsorted Array functions to manipulate arrays without sorting first.

Palette
Description
Object

Search Searches for an element in an unsorted 1D array starting at start index. The search is
Unsorted linear and LabVIEW stops searching as soon as the element is found. The connector pane
1D Array displays the default data types for this polymorphic function.

Returns a sorted version of unsorted array with the elements arranged in ascending
order. If unsorted array is an array of clusters, the function sorts the elements by
Sort 1D
comparing the first elements. If the first elements match, the function compares the
Array
second and subsequent elements. The connector pane displays the default data types
for this polymorphic function.

430 ni.com
Functions

Search Unsorted 1D Array

Searches for an element in an unsorted 1D array starting at start index. The search is
linear and LabVIEW stops searching as soon as the element is found. The connector
pane displays the default data types for this polymorphic function.

Inputs/Outputs
• unsorted 1D array —

unsorted 1D array can be a 1D array of any type.

• element —

element is the value to search for in the array. element must be the same data type as the
elements in 1D array.

• start index (0) —

start index is the index that LabVIEW begins the search from. The default is 0.

• equals function (built-in =) —

equals function is the comparison used to search the array. By default, this is the same
comparison the standard Equal? function uses.

If the array element is a class with an Equals method that includes two inputs of the same type
and a boolean output in the connector pane , the default changes to use that comparison.

To specify a different sort order, wire this terminal to one of the following objects:

• A class that defines a Equals method with the following connector pane configuration :
◦ A functor input in the top-left. A functor is a class that defines an operation on a data
type.
◦ Two inputs of the same data type as the array elements.
◦ A boolean output between two empty outputs.

© National Instruments 431


Functions

• A VI refnum with the following connector pane configuration :

◦ Two inputs of the same data type as the array elements.


◦ A boolean output.

The comparison function must be symmetric. If a<b is true, b<a is false. If a and b are the same
value, both a<b and b<a are false. If the function is not symmetric, the search results will be
unpredictable.

• index of element —

index of element is the index where element is found.

If the function does not find element, index of element is –1.

You cannot use this function to retrieve the index of a value that is not an element of
the array. For example, if you have an array of two elements (0.0 and 1.0), this function
does not find the index of the value 0.5, as that value is not an element of the array.
Use the Threshold 1D Array to find a fractional index or specify an alternate
comparison in the equals function input to find the first value within some epsilon.

This function only finds a string if the element you specify matches an array element
exactly. To search a string for any occurrence of a regular expression, use the Match
Regular Expression function or specify an alternate comparison in the equals function
input.

Sort 1D Array

Returns a sorted version of unsorted array with the elements arranged in ascending
order. If unsorted array is an array of clusters, the function sorts the elements by
comparing the first elements. If the first elements match, the function compares the
second and subsequent elements. The connector pane displays the default data types
for this polymorphic function.

432 ni.com
Functions

Inputs/Outputs
• unsorted array —

unsorted array can be a 1D array of any type.

• less function (built-in <) —

less function is the comparison used to search the array. By default, this is the same comparison
the standard Less? function uses.

If the array element is a class with a Less Than method that includes two inputs of the same type
and a boolean output in the connector pane , the default changes to use that comparison.

To specify a different sort order, wire this terminal to one of the following objects:

• A class that defines a Less Than method with the following connector pane configuration
:
◦ A functor input in the top-left. A functor is a class that defines an operation on a data
type.
◦ Two inputs of the same data type as the array elements.
◦ A boolean output.

• A VI refnum with the following connector pane configuration :

◦ Two inputs of the same data type as the array elements.


◦ A boolean output.

The comparison function must be symmetric. If a<b is true, b<a is false. If a and b are the same
value, both a<b and b<a are false. If the function is not symmetric, the search results will be
unpredictable.

• sorted array —

sorted array is the output array.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Nested Malleable VIs\


Malleable VIs - Nested Malleable VIs.lvproj

© National Instruments 433


Functions

Sorted Array

Use the Sorted Array functions to manipulate sorted arrays while maintaining the
sorted order.

Palette
Description
Object

Search
Searches for the first instance of element in sorted 1D array. If the array is not sorted, the
Sorted
results will be incorrect. The connector pane displays the default data types for this
1D
polymorphic function.
Array

Insert
Inserts element into sorted array in while maintaining sorted order. If the array is not
Into
sorted, the element may be inserted at the wrong location. The connector pane displays
Sorted
the default data types for this polymorphic function.
Array

Search Sorted 1D Array

Searches for the first instance of element in sorted 1D array. If the array is not sorted,
the results will be incorrect. The connector pane displays the default data types for this
polymorphic function.

Inputs/Outputs
• sorted 1D array —

sorted 1D array can be a 1D array of any type.

• element —

434 ni.com
Functions

element is the value to insert into the array. element must be the same data type as the
elements in sorted 1D array.

• less function (built-in <) —

less function is the comparison used to search the array. By default, this is the same comparison
the standard Less? function uses.

If the array element is a class with a Less Than method that includes two inputs of the same type
and a boolean output in the connector pane , the default changes to use that comparison.

To specify a different sort order, wire this terminal to one of the following objects:

• A class that defines a Less Than method with the following connector pane configuration
:
◦ A functor input in the top-left. A functor is a class that defines an operation on a data
type.
◦ Two inputs of the same data type as the array elements.
◦ A boolean output.

• A VI refnum with the following connector pane configuration :

◦ Two inputs of the same data type as the array elements.


◦ A boolean output.

The comparison function must be symmetric. If a<b is true, b<a is false. If a and b are the same
value, both a<b and b<a are false. If the function is not symmetric, the search results will be
unpredictable.

• found? —

found? indicates whether the element was found.

• nearest index —

nearest index is the index of the element if found? is TRUE. If found? is FALSE, nearest index is
the index where the element would have been in the sorted array.

If element is greater than all the elements in the array, nearest index is equal to the size of the
array. If element is less than all the elements in the array, nearest index is 0. If you search an
empty array, nearest index is 0.

© National Instruments 435


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Nested Malleable VIs\


Malleable VIs - Nested Malleable VIs.lvproj

Insert Into Sorted Array

Inserts element into sorted array in while maintaining sorted order. If the array is not
sorted, the element may be inserted at the wrong location. The connector pane
displays the default data types for this polymorphic function.

Inputs/Outputs
• sorted array in —

sorted array in can be a 1D array of any type.

• element —

element is the value to insert into the array. element must be the same data type as the
elements in sorted array in.

• less function (built-in <) —

less function is the comparison used to search the array. By default, this is the same comparison
the standard Less? function uses.

If the array element is a class with a Less Than method that includes two inputs of the same type
and a boolean output in the connector pane , the default changes to use that comparison.

To specify a different sort order, wire this terminal to one of the following objects:

• A class that defines a Less Than method with the following connector pane configuration
:

436 ni.com
Functions

◦ A functor input in the top-left. A functor is a class that defines an operation on a data
type.
◦ Two inputs of the same data type as the array elements.
◦ A boolean output.

• A VI refnum with the following connector pane configuration :

◦ Two inputs of the same data type as the array elements.


◦ A boolean output.

The comparison function must be symmetric. If a<b is true, b<a is false. If a and b are the same
value, both a<b and b<a are false. If the function is not symmetric, the search results will be
unpredictable.

• sorted array out —

sorted array out is the sorted array with the new element.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Nested Malleable VIs\


Malleable VIs - Nested Malleable VIs.lvproj

Matrix

Use the Matrix functions to manipulate the elements, diagonals, and submatrices of a
matrix or 2D numeric array. Many of these functions complement existing array
operations but offer functionality for math algorithms based on matrices.

Palette Object Description


Matrix Size
Returns the dimensions for the number of rows and columns of matrix.
Function
Build Matrix Appends elements to a matrix by rows or columns.

© National Instruments 437


Functions

Palette Object Description


Resize Matrix Resizes matrix with new row and column dimensions based on the number of
Function rows and columns you specify.
Transpose Matrix
Returns the conjugate transpose of matrix.
Function
Get Matrix
Returns the diagonal of matrix beginning at the index (row, column).
Diagonal
Get Matrix
Returns the elements of matrix at row and column.
Elements
Returns a submatrix of matrix starting at (row 1, column 1) and ending at (row
Get Submatrix
N, column N).
Set Matrix
Sets the diagonal of matrix beginning at (row, column).
Diagonal
Set Matrix Sets one or more elements in matrix at the indexes you specify in row and
Elements column.
Adds a submatrix to matrix starting at (row 1, column 1) and ending at (row N,
Set Submatrix
column N).

Matrix Size Function

Returns the dimensions for the number of rows and columns of matrix.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• matrix —

number of rows is the row dimension of the matrix.

• number of rows —

number of columns is the column dimension of the matrix.

438 ni.com
Functions

• number of columns —

matrix must be a 2D array of any numeric type or a real or complex matrix.

Build Matrix

Appends elements to a matrix by rows or columns.

You also can use the Set Matrix Elements and Set Submatrix functions to modify an
existing matrix.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• element —

matrix or element can be a numeric scalar, a real or complex matrix, or a 1D or 2D array of any
numeric type.

• appended array —

appended matrix is the resulting matrix.

When you add the function to the block diagram, it has only one input available. Add
inputs to the node by right-clicking an input and selecting Add Input from the shortcut
menu or by resizing the node.

The Build Matrix function operates in one of two different modes: Append by Rows or
Append by Columns. When you add the function to the block diagram, the default
mode is Append by Columns.

If you right-click the function and select Build Matrix Mode»Append by Rows, the

© National Instruments 439


Functions

function adds each new element or matrix to the last row starting in the first column. If
you right-click the function and select Build Matrix Mode»Append by Columns, the
function adds each new element or matrix to the last column starting in the first row.

If the inputs you wire to the Build Matrix function have different dimensions, LabVIEW
creates appended matrix by padding the smaller input with the scalar default value.

Wiring Empty Input Values

If element is an empty matrix or array, the function ignores the empty dimensions.
However, the dimensions and data type of element affect the dimensions and data
type of appended matrix.

Wiring Different Numeric Types

If you wire inputs of different numeric types to the Build Matrix function, appended
matrix stores all inputs without losing precision.

Resize Matrix Function

Resizes matrix with new row and column dimensions based on the number of rows
and columns you specify.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• number of rows —

number of rows specifies the new row dimension.

• number of columns —

440 ni.com
Functions

number of columns specifies the new column dimension.

• resized matrix —

resized matrix is matrix with the number of rows and columns you specify in number of rows
and number of columns.

If you do not wire number of rows, the function uses the row dimension of matrix to
determine the number of rows in resized matrix. If you do not wire number of
columns, the function uses the column dimension of matrix to determine the number
of columns in resized matrix.

If you increase the row or column dimensions of matrix, the function returns 0 at each
exterior location.

This function only retains elements within the new row or column dimensions you
specify in number of rows and number of columns. If any elements in matrix have row
or column indexes outside the new row or column dimensions, respectively, this
function removes the elements from resized matrix.

Transpose Matrix Function

Returns the conjugate transpose of matrix.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• transposed matrix —

transposed matrix is the output matrix with transposed elements.

© National Instruments 441


Functions

The conjugate transpose of matrix rearranges the elements so that the element at
index (i, j) in matrix becomes the conjugate of the element at (j, i) in transposed
matrix. For a real matrix, the transpose and conjugate transpose operations produce
the same result.

Get Matrix Diagonal

Returns the diagonal of matrix beginning at the index (row, column).

Add additional row and column inputs and matrix diagonal outputs by resizing the
node.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• index (row) —

row must be an integer or real number. row is the starting row index in the output. The default is
0.

• index (col) —

column must be an integer or real number. column is the starting column index in the output.
The default is 0.

• diagonal —

matrix diagonal is the matrix or 2D array that contains the diagonal elements in matrix.

The matrix diagonal output is a matrix or 2D array with one column and has the same
the numeric type as matrix. If you wire a matrix to matrix, matrix diagonal returns a

442 ni.com
Functions

column vector. If you wire a 2D array to matrix, matrix diagonal returns a 2D array.

If you do not wire row and column, matrix diagonal returns the main diagonal of
matrix. If you do not wire column, matrix diagonal returns a lower diagonal. If you do
not wire row, matrix diagonal returns an upper diagonal.

Indexing Outside Input Values

If you wire a negative value to row and no value to column, matrix diagonal returns
the same results as if you wired the same positive value to column and left row
unwired. If you wire a negative index to column and no value to row, matrix diagonal
returns the same result as if you wired the same positive value to row and left column
unwired.

If you wire values to row and column and one value is negative, the other value must
be 0. If the other value is not 0, matrix diagonal returns an empty matrix or array.

If you wire a value to row that is greater than or equal to the matrix row dimension or a
value to column that is greater than or equal to the matrix column dimension, matrix
diagonal returns an empty matrix or array.

Extracting Subdiagonals

If you wire positive values to row and column that are less than the row and column
dimensions of the matrix, the function returns a subdiagonal. The subdiagonal
includes the diagonal elements starting at (row, column) and ending at the last
element of the diagonal.

If row is less than column, matrix diagonal returns a portion of the upper diagonal. If
row is greater than column, matrix diagonal returns a portion of the lower diagonal. If
row equals column, matrix diagonal returns a portion of the main diagonal.

Get Matrix Elements

Returns the elements of matrix at row and column.

The row and column inputs specify row and column indexes. If you wire scalar data to
row and column, for example i for row and j for column, the function returns a scalar

© National Instruments 443


Functions

that contains the element at location (i, j).

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• index (row) —

row must be an integer, a floating-point numeric, a 1D array of integers, or a 1D array of a


floating-point numeric.

The default is a 1D array of integers that contains all row indexes.

• index (col) —

column must be an integer, a floating-point numeric, a 1D array of integers, or a 1D array of a


floating-point numeric.

The default is 0.

• output matrix —

element is the scalar, matrix, or 2D array that contains the matrix elements. The data type of
element is the same as the data type of matrix.

Add additional row and column inputs and element outputs by resizing the node.

If matrix is an empty matrix or array, element returns an invalid operation value at


each exterior location.

If you do not wire row and column, element returns a column vector with the first
column of matrix.

444 ni.com
Functions

If you do not wire column and you wire a numeric scalar to row, element returns a row
vector with the index of row. If you do not wire row and you wire a numeric scalar to
column, element returns a column vector with the index of column.

If you wire a 1D array of indexes to either row or column and no value to the other
index input, element returns a matrix.

If you wire a 1D array of numeric data to row or column, the function returns one
matrix element for every location specified. These locations are determined by pairing
each row index in row with each column index in column. For example, passing the
array of integers {1, 2, 4} to row and the integer {5} to column retrieves matrix elements
at indexes (1, 5), (2, 5), and (4, 5). In this case, the output is a row vector, or a 3 x 1
matrix, because the number of scalar elements wired to row is 3 and the number of
scalars elements wired to column is 1.

Wiring Empty Input Values

If you wire an empty 1D array to row or column, element returns an empty matrix or
array with 0 in the corresponding row or column dimension.

Indexing Outside Input Values

If you wire a negative value to row or column, the function returns an invalid operation
value at each exterior location.

If you wire a value to row or column that is greater than the row or column dimension
of matrix, the function returns an invalid operation value at each exterior location.

Get Submatrix

Returns a submatrix of matrix starting at (row 1, column 1) and ending at (row N,


column N).

To retrieve elements that are not next to each other in matrix, use the Get Matrix
Elements function.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 445


Functions

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• row 1 —

row 1 must be an integer or real numeric. row 1 specifies the first row in matrix you want to
appear in the output.

The default is 0.

• row N —

row N must be an integer or real numeric. row N specifies the last row in matrix you want to
appear in the output.

The default is the index of the last row in matrix.

• column 1 —

column 1 must be an integer or real numeric. column 1 specifies the first column in matrix you
want to appear in the output.

The default is 0.

• column N —

column N must be an integer or real numeric. column N specifies the last column in matrix you
want to appear in the output.

The default is the index of the last column in matrix.

• submatrix —

submatrix is a matrix that contains the submatrix. If matrix is an empty matrix or array,
submatrix returns matrix.

446 ni.com
Functions

If you wire a matrix to matrix, submatrix returns a matrix with the same numeric type
as matrix. If you wire a 2D array to matrix, submatrix returns a 2D array with the same
numeric type as matrix.

If you wire matrix but you do not wire the other inputs, submatrix returns matrix. If
you do not wire inputs to row 1 and column 1, submatrix starts with the first element
of matrix. If you do not wire inputs to row N and column N, submatrix ends with the
last element of matrix.

Wiring Empty Input Values

If row N is less than row 1 or if column N is less than column 1, submatrix returns an
empty matrix or array with 0 for the row or column dimensions where appropriate.

Indexing Outside Input Values

If you wire a negative value to any of the row or column indexes, submatrix returns
each row and column element outside matrix with an invalid operation value at each
exterior location.

If you wire a value to row N or column N that is greater than or equal to the row or
column dimensions of matrix, submatrix returns each row and column element
outside matrix with an invalid operation value at each exterior location.

Set Matrix Diagonal

Sets the diagonal of matrix beginning at (row, column).

Add additional row, column, and new diagonal inputs and output matrix outputs by
resizing the node.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 447


Functions

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• disabled index (row) —

row must be an integer or real number. row is the starting row index in the output. The default is
0.

• index (col) —

column must be an integer or real number. column is the starting column index in the output.
The default is 0.

• new diagonal/fill element —

new diagonal can be a real or complex matrix or a 2D array of any numeric type. new diagonal
specifies the elements to set.

• output matrix —

output matrix is the matrix with the new diagonal.

If you wire matrix and no other inputs, output matrix returns matrix with the main
diagonal set to zero. If you wire column without row, output matrix returns matrix
with the upper diagonal starting at (0, column) set to the new diagonal elements. If
you wire row without column, output matrix returns matrix with the lower diagonal
starting at (row, 0) set to the new diagonal elements.

If you wire a matrix to new diagonal, the matrix must be a column vector with one
column or a row vector with one row. If you wire a 2D array to new diagonal, one
dimension of the array needs to be equal to 1.

Indexing Outside Input Values

If you wire a negative value to one index input and a positive value to the other index
input, output matrix returns an empty matrix or array.

If you wire a negative input to row and no input to column, output matrix returns the

448 ni.com
Functions

same result as if you wired the same positive value to column and left row unwired. If
you wire a negative value to column and no input to row, output matrix returns the
same result as if you wired the same positive value to row and left column unwired.

If you wire values to row or column that are greater than or equal to the respective row
or column dimensions of matrix, matrix resizes to accept the new diagonal elements.
If you increase the row or column dimensions of matrix, the function returns 0 at each
exterior location.

Wiring the New Diagonal Input

If you wire an empty matrix or a 2D array to new diagonal, output matrix returns
matrix.

If you wire new diagonal with an input that contains fewer elements than the diagonal
or subdiagonal that starts at (row, column), output matrix returns matrix with only
the first elements in the diagonal or subdiagonal set to the new diagonal elements.

If you wire an input to new diagonal that contains more elements than the diagonal or
subdiagonal that starts at (row, column), matrix resizes to receive the new diagonal
elements.

If you wire an input to new diagonal with a different numeric type than matrix, the
function converts matrix to the new numeric type if the function cannot set new
diagonal elements without losing precision. If the function can set new diagonal
elements without losing precision, the numeric type of new diagonal converts to the
numeric type of matrix.

If you wire a real or complex matrix to matrix, output matrix returns a real or complex
matrix. The table of special coercion cases shows the situations when output matrix is
different from matrix.

Set Matrix Elements

Sets one or more elements in matrix at the indexes you specify in row and column.

The row and column inputs specify row and column indexes. For example, if you wire
numeric scalar values i and j to row and column, respectively, these inputs correspond

© National Instruments 449


Functions

to a single matrix element at location (i, j).

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• disabled index (row) —

row must be an integer, a floating-point numeric, a 1D array of integers, or a 1D array of a


floating-point numeric.

• index (col) —

column must be an integer, a floating-point numeric, a 1D array of integers, or a 1D array of a


floating-point numeric.

• new element/submatrix —

new element is the scalar, matrix, or 2D array that replaces one or more elements in matrix.

• output matrix —

output matrix is the matrix with the new elements. If matrix is an empty matrix or array, output
matrix resizes to receive the new elements.

Add additional row, column, and new element inputs and output matrix outputs by
resizing the node.

If you wire a 2D array to matrix, output matrix returns an array even if you wire a real
or complex matrix to new element.

If new element is a scalar or a matrix, output matrix returns matrix with the element

450 ni.com
Functions

at location (i, j) set to the new element. If the location is outside the matrix and i and j
are non-negative, matrix resizes to accept the new scalar or matrix. If the new matrix is
larger than the largest submatrix at the starting location, the matrix also resizes. If you
increase the row or column dimensions of matrix, the function returns 0 at each
exterior location.

If you wire a 1D array of numeric type to row or column, the function sets one matrix
element for every location specified. These locations are determined by pairing each
row index in row with every column index in column. For example, passing the array of
integers {1, 2, 4} to row and the integer {5} to column modifies matrix elements at
indexes (1, 5), (2, 5), and (4, 5).

If you do not wire row or column, the function assigns the new element to the input
matrix starting at index (0, 0), which is equivalent to wiring 0 to matrix. If you do not
wire an input to new element, the function sets the element at location (row, column)
in matrix to 0.

Wiring Empty Input Values

If you wire an empty 1D array to row or column, output matrix returns matrix.

Indexing Duplicate Values

If you wire duplicate values to row or column and you wire a matrix to new element,
the order in which the function sets the new matrix elements determines output
matrix.

Indexing Outside the Input

If you wire a negative value to row or column, the function ignores all locations
specified by the negative index. If new element is a matrix, the function ignores the
new matrix elements that fill these locations as well.

If you wire a value to row or column that is greater than or equal to the row or column
dimension of matrix, matrix resizes to receive elements at the corresponding location.
If you increase the row or column dimensions of matrix, the function returns an invalid
operation value at each exterior location.

© National Instruments 451


Functions

Wiring the New Element Input

If you wire a matrix to element that has a dimension larger than matrix, matrix resizes
to receive the new matrix elements. If you increase the row or column dimensions of
matrix, the function returns an invalid operation value at each exterior location.

If you wire a matrix to new element in which the row or column dimensions exceed the
respective number of row indexes in row or column indexes in column, the function
ignores the additional row and column elements.

If you wire a matrix to new element in which the number of row indexes is less than
the row dimension of the new matrix and you wire a 1D array to row, the function
inserts an invalid operation value at each exterior location.

If you wire a matrix to new element in which the number of column indexes is less
than the column dimension of the new matrix and you wire a 1D array to column, the
function fills in an invalid operation value at each exterior location.

If you wire an input to new element with a different numeric type than matrix, the
function converts matrix to a new numeric type if the function cannot set new
elements without losing precision. If the function can set new elements without losing
precision, the numeric type of new elements converts to the numeric type of matrix.

If you wire a real or complex matrix to matrix, output matrix returns a real or complex
matrix. The table of special coercion cases shows the situations when output matrix is
different from matrix.

Set Submatrix

Adds a submatrix to matrix starting at (row 1, column 1) and ending at (row N, column
N).

Add additional row, column, and new submatrix inputs and output matrix outputs by
resizing the node.

The connector pane displays the default data types for this polymorphic function.

452 ni.com
Functions

Inputs/Outputs
• matrix —

matrix must be a 2D array of any numeric type or a real or complex matrix.

• row 1 —

row 1 must be an integer or real numeric. row 1 specifies the first row in matrix you want to
appear in the output.

The default is 0.

• row N —

row N must be an integer or real numeric. row N specifies the last row in matrix you want to
appear in the output.

The default is the index of the last row in matrix.

• column 1 —

column 1 must be an integer or real numeric. column 1 specifies the first column in matrix you
want to appear in the output.

The default is 0.

• column N —

column N must be an integer or real numeric. column N specifies the last column in matrix you
want to appear in the output.

The default is the index of the last column in matrix.

• new submatrix/fill element —

new submatrix can be a real or complex matrix, a 2D array of any numeric type, or a numeric
scalar. If you do not wire an input to new submatrix, the default is 0.

© National Instruments 453


Functions

• output matrix —

output matrix is the matrix with the new submatrix. If matrix is an empty matrix or array, output
matrix resizes to receive the new elements.

If you wire a 2D array to matrix, output matrix returns an array even if you wire a real
or complex matrix to new submatrix.

If you wire an input to matrix and you do not wire the other inputs, output matrix
returns matrix with every element set to 0. If you wire a scalar input to new submatrix,
every element in output matrix is set to the scalar value.

If you wire an input to matrix and a matrix to new submatrix, output matrix resizes
with the new submatrix elements in output matrix. If the function needs to add rows
or columns to the new submatrix, the function returns 0 at each exterior location.

Wiring Empty Input Values

If row N is less than row 1 or column N is less than column 1, output matrix returns
matrix.

Indexing Outside Input Values

If you wire a negative value to row or column, the function ignores the rows and
columns of the submatrix with negative indexes. If new submatrix is a matrix, the
function also ignores the new submatrix elements that fill these rows and columns.

If you wire a value to row N or column N that is greater than or equal to the row or
column dimension of matrix, matrix resizes to receive the new elements.

Wiring the New Submatrix Input

If you wire a matrix to new submatrix when it has a dimension larger than matrix,
matrix resizes to receive the new submatrix elements. If you increase the row or
column dimensions of matrix, the function sets the new elements to an invalid
operation value at each exterior location.

If you wire a matrix to new submatrix when the dimensions of the row or column

454 ni.com
Functions

inputs are less than the number of rows or columns in the submatrix, the function
ignores the additional row and column elements in the new submatrix.

If you wire a matrix to new submatrix when the dimensions of the row or column
inputs exceed the number of rows or columns in the submatrix, the function inserts an
invalid operation value at each exterior location.

If you wire an input to new submatrix with a different numeric type than matrix, the
function converts matrix to a new numeric type if the function cannot set new
submatrix elements without losing precision. If the function cannot set new submatrix
elements without losing precision, the numeric type of new submatrix converts to the
numeric type of matrix.

If you wire a real or complex matrix to matrix, output matrix returns a real or complex
matrix. The table of special coercion cases shows the situations when output matrix is
different from matrix.

Cluster, Class, & Variant


Use the Cluster, Class & Variant VIs and functions to create and manipulate clusters
and LabVIEW classes, convert LabVIEW data to a format you can manipulate
independent of data type, add attributes to the data, and convert variant data to
LabVIEW data.

Related Information

Creating LabVIEW Classes

Grouping Data with Arrays and Clusters

Handling Variant Data

© National Instruments 455


Functions

Palette
Description
Object
Unbundle
Returns the cluster elements whose names you specify.
By Name
Bundle Replaces one or more cluster elements. This function refers to cluster elements by
By Name name instead of by their position in the cluster.
Unbundle Splits a cluster into each of its individual elements.
Bundle Assembles a cluster from individual elements.
Cluster
Use this constant to supply a constant cluster value to the block diagram.
Constant
Build
Bundles each element input into a cluster and assembles all element clusters into an
Cluster
array of clusters.
Array
Index &
Bundle Indexes a set of arrays and creates a cluster array in which the ith element contains the
Cluster ith element of each input array.
Array
Cluster
Converts a cluster of elements of the same data type to a 1D array of elements of the
To Array
same data type.
Function
Array To Converts a 1D array to a cluster of elements of the same type as the array elements.
Cluster Double-click the function to open the Cluster Size dialog box and set the number of
Function elements in the cluster.
Calls the nearest ancestor implementation of a class method. You can use the Call
Call
Parent Class Method node only on the block diagram of a member VI that belongs to a
Parent
class that inherits member VIs from an ancestor class. The child member VI must be a
Class
dynamic dispatching member VI and have the same name as the ancestor member VI.
Method
You cannot use this node to invoke methods from ancestor interfaces.
To More
Specific Typecasts a reference, such as a control or a type definition, to a more specific class or
Class interface in the inheritance hierarchy.
Function
To More
Generic Typecasts a reference, such as a control or a type definition, to a more generic class or
Class interface in the inheritance hierarchy.
Function

456 ni.com
Functions

Palette
Description
Object
Checks at run time whether object in is of the same class as, or is a child class of, target
Preserve
object. Use this function on the block diagram of a subVI when you want to guarantee
Run-Time
that LabVIEW downcasts a LabVIEW class output of the subVI node to the same class
Class
type as a LabVIEW class input when the subVI receives a child class of the expected
Function
input type.

The LabVIEW Object is the common ancestor data type for all LabVIEW classes and
LV Object
interfaces. You can use the LabVIEW Object to create generic methods that can handle
Constant
all LabVIEW class and interface data types.

Returns the class data for the class whose path you wire to the class path input. If the
Get LV
class is not in memory, LabVIEW attempts to load it from disk. If any dependencies are
Class
missing, LabVIEW searches for the missing dependencies. If LabVIEW cannot find the
Default
dependency, LabVIEW assumes the dependency is missing and does not prompt the
Value
user to browse to the needed file.

Get LV
Class Returns the path to the class of the object.
Path
Get LV
Class
Returns the class data for the class whose name you wire to the class name input. If the
Default
class is not in memory or is broken, LabVIEW returns an error.
Value By
Name
Get LV
Class Returns the name of the class of the object.
Name

Use the Variant VIs and functions to add, retrieve, and delete attributes in LabVIEW
Variant
variants, manipulate variants, and retrieve data types of variants.

Unbundle By Name

Returns the cluster elements whose names you specify.

© National Instruments 457


Functions

You do not have to keep track of the order of the elements within the cluster. This
function does not require the number of elements to match the number in the cluster.
After you wire a cluster to this function, you can select an individual element from the
function.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• input cluster —

input cluster is the cluster whose elements you want to access.

• element —

element 0..m-1 is the element of input cluster called name 0..m-1.

You can access only elements with owned labels. To select a named element, click a name
terminal and select a name from the shortcut menu.

Bundle By Name

Replaces one or more cluster elements. This function refers to cluster elements by
name instead of by their position in the cluster.

After you wire the node to an input cluster, right-click the name terminals to select
elements from the shortcut menu. You also can use the Operating tool to click the
name terminals and select from a list of cluster elements. The connector pane displays
the default data types for this polymorphic function.

458 ni.com
Functions

Inputs/Outputs
• input cluster —

input cluster is the cluster whose elements you want to replace.

At least one element of input cluster must have an owned label. You must always wire the input
cluster terminal.

• element —

element 0..m-1 are the elements of input cluster you want to replace by name.

You only can replace elements with owned labels. Select the correct element 0..m-1 by clicking
a name terminal and selecting a name from the shortcut menu.

• output cluster —

output cluster is the cluster whose value is the resulting cluster.

When you use the Bundle by Name function on nested clusters, you can display both
the element name and the owning cluster name for elements in the nested cluster by
right-clicking the function and selecting Show Full Names. This is useful when
element names in nested clusters are identical or similar.

Unbundle

Splits a cluster into each of its individual elements.

When you wire a cluster to this function, the function resizes automatically to display
outputs for each element in the cluster you wired. The connector pane displays the
default data types for this polymorphic function.

Inputs/Outputs
• cluster —

© National Instruments 459


Functions

cluster is the cluster whose elements you want to access.

• —

element 0..n-1 are the elements of cluster.

• —

This function produces as an output these elements in the same order they appear in
the cluster. The number of outputs for this function must match the number of
elements in the cluster. When you have two or more elements of the same type, keep
track of their order in the cluster. If you access the wrong element by mistake, LabVIEW
does not report this as an error.

Bundle

Assembles a cluster from individual elements.

You also can use this function to change the values of individual elements in an
existing cluster without having to specify new values for all elements. To do so, wire
the cluster you want to change to the middle cluster terminal of this function. When
you wire a cluster to this function, the function resizes automatically to display inputs
for each element in the cluster. The connector pane displays the default data types for
this polymorphic function.

Inputs/Outputs
• cluster —

cluster is the cluster whose value you want to change. If you do not wire this input, the function
creates a cluster.

460 ni.com
Functions

If you wire cluster, the Bundle function replaces the elements of cluster with element 0..n-1. If
you wire a cluster, the number of input terminals must match the number of elements in the
input cluster.

• —

• —

• —

element 0..n-1 accepts any data type.

• —

• output cluster —

output cluster is the resulting cluster.

• —

• —

Resize this function to indicate the number of elements in a new cluster. You cannot
resize this function when an existing cluster is wired to the cluster input.

When you create a new cluster, you must wire all the inputs. The elements in the
output cluster must appear in the same order as the input elements. When you wire an
existing cluster to the middle terminal of this function, the inputs are optional.
LabVIEW replaces only those cluster elements that you wire.

Cluster Constant

Use this constant to supply a constant cluster value to the block diagram.

The elements of the cluster can be different types. Define a cluster constant by
selecting any user-defined constant on the Functions palette and placing it inside the
cluster constant. Edit each cluster element value by using the Operating tool and the

© National Instruments 461


Functions

Labeling tool.

You cannot change the value of the cluster constant while the VI runs.

Note To reduce the size of cluster constants on the block diagram, right-click
the cluster constant and select View Cluster As Icon from the shortcut menu.
To undo this change, select View Cluster As Icon again from the shortcut
menu. You also can double-click the frame of the cluster constant to view it
as an icon. To undo this change, double-click the cluster constant icon.

Build Cluster Array

Bundles each element input into a cluster and assembles all element clusters into an
array of clusters.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• element —

element 0..n-1 inputs must be of the same type as the value wired to the topmost element
terminal.

• array of clusters —

array of clusters is the resulting array. Each cluster contains a single element.

• —

462 ni.com
Functions

You cannot create arrays of arrays. However, you can use this function to create an
array of clusters where each cluster contains an array.

The following example demonstrates two ways to build an array of clusters. You can
use the Build Cluster Array function to increase implementation efficiency, as shown in
the bottom section of the following example.

Index & Bundle Cluster Array

Indexes a set of arrays and creates a cluster array in which the ith element contains the
ith element of each input array.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• array —

© National Instruments 463


Functions

array of x..z can be a 1D array of any type. Array inputs do not all have to be the same type.

• array of clusters —

array of cluster is a cluster array containing one element from each input array. The number of
elements in the output array equals the number of elements in the shortest input array.

• —

The following block diagram demonstrates two ways to index a set of arrays and build
a cluster. You can use the Index & Bundle Cluster Array function to improve both
implementation time and memory usage.

Cluster To Array Function

Converts a cluster of elements of the same data type to a 1D array of elements of the
same data type.

464 ni.com
Functions

Inputs/Outputs
• cluster —

The cluster components cannot be arrays.

• —

• array —

The elements in array are of the same type as the elements in cluster.

The order of the elements in array is the same as the cluster order of the elements.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Array to Cluster.vi

Array To Cluster Function

Converts a 1D array to a cluster of elements of the same type as the array elements.
Double-click the function to open the Cluster Size dialog box and set the number of
elements in the cluster.

The default is nine. The maximum cluster size for this function is 256.

Use this function when you want to display elements of the same type in a front panel
cluster indicator but want to manipulate the elements on the block diagram by their
index values.

© National Instruments 465


Functions

Inputs/Outputs
• array —

array is a one-dimensional array of any type.

• cluster —

Each element in cluster is the same as the corresponding element in array.

The cluster order matches the order of the elements in the array.

• —

• —

• —

• —

• —

• —

• —

• —

• —

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Array to Cluster.vi

Call Parent Class Method

Calls the nearest ancestor implementation of a class method. You can use the Call
Parent Class Method node only on the block diagram of a member VI that belongs to a

466 ni.com
Functions

class that inherits member VIs from an ancestor class. The child member VI must be a
dynamic dispatching member VI and have the same name as the ancestor member VI.
You cannot use this node to invoke methods from ancestor interfaces.

The parameters, or input and output terminals, of this node depend on the ancestor
member VI and change to match the ancestor member VI exactly. This node adopts the
VI icon of the ancestor member VI with a glyph in the bottom, left corner of the subVI to
indicate the subVI is calling the ancestor member VI instead of dynamically dispatching
as a dynamic subVI node does typically.

Inputs/Outputs
• —

Related Information

Creating LabVIEW Classes

Creating a Member VI in a LabVIEW Class

To More Specific Class Function

Typecasts a reference, such as a control or a type definition, to a more specific class or


interface in the inheritance hierarchy.

For example, if Class A inherits from Class B, a variable of type B can hold a value of
type A. You can use the function to downcast from type B to type A. If the typecast is
invalid, this function returns an error at run time.

You can use the To More Specific Class function for casting any class hierarchy in
LabVIEW, including VI Server refnums, .NET/ActiveX refnums, and LabVIEW classes or
interfaces.

© National Instruments 467


Functions

Inputs/Outputs
• target class —

target class is the class or interface to which you want to downcast reference.

You can wire a class specifier constant or any wire of the target type to this input.
• reference —

reference is the refnum or LabVIEW class or interface to downcast.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• specific class reference —

specific class reference is the downcast reference.

If the target class is incompatible with the reference, the function returns an error and specific
class reference is Not A Refnum.
• error out —

error out contains error information. This output provides standard error out functionality.

You can use the To More Specific Class function to manipulate the properties or
methods from a more specific class or interface than that of the reference. For
example, if you build an array of references to boolean, numeric, and string controls,
LabVIEW casts these references to the more generic Control class because an array can
contain only one data type, and each of these controls is a member of the Control
class. If you then want to manipulate the properties for only the boolean controls in
the array, you can create a reference to the array and use the To More Specific Class
function to downcast the array reference to the Boolean class.

Wire a VI refnum to reference and a Facade VI refnum to target class to downcast from
VI to Facade VI.

468 ni.com
Functions

You also can use data value references to downcast classes. The To More Specific Class
function waits to execute until the reference is available for downcast. To downcast a
class or interface, wire the data value reference of the target class or interface to target
class.

Related Information

Casting LabVIEW Classes

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Application Control\VI Server\To More


Specific Class\To More Specific Class.vi

To More Generic Class Function

Typecasts a reference, such as a control or a type definition, to a more generic class or


interface in the inheritance hierarchy.

For example, if Class A inherits from Class B, the function upcasts a variable of type A
to a variable of type B.

You can use the To More Generic Class function for casting any class hierarchy in
LabVIEW, including VI Server refnums, .NET/ActiveX refnums, and LabVIEW classes or
interfaces.

Inputs/Outputs
• target class —

target class is the class or interface to which you want to upcast reference.

You can wire a class specifier constant or any wire of the target type to this input.

© National Instruments 469


Functions

• reference —

reference is the refnum or LabVIEW class or interface to upcast.

• generic class reference —

generic class reference is the upcasted reference.

If an error occurs, generic class reference is Not A Refnum.

This function does not have error in and error out parameters because LabVIEW can
determine at edit time whether you have wired the reference to a compatible target
class. If you wire the reference to an incompatible target class, the wire breaks and
you receive a Class conflict error.

You can use the To More Generic Class function to manipulate the properties or
methods from a more generic class or interface than that of the reference. For
example, you can wire an enum control reference to the To More Generic Class
function to upcast the reference to the Numeric class. You then can manipulate the
Numeric class properties of the control, but you no longer can access the specific
properties of the Enum class.

Wire a Facade VI refnum to reference and a VI refnum to target class to upcast from
Facade VI to VI.

Related Information

Casting LabVIEW Classes

Preserve Run-Time Class Function

Checks at run time whether object in is of the same class as, or is a child class of,
target object. Use this function on the block diagram of a subVI when you want to
guarantee that LabVIEW downcasts a LabVIEW class output of the subVI node to the
same class type as a LabVIEW class input when the subVI receives a child class of the
expected input type.

470 ni.com
Functions

Inputs/Outputs
• target object —

target object—is the object whose class you want to compare to the class of object in.

• object in —

object in—is the object you want LabVIEW to downcast automatically.

• error in —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• object out —

object out—is the same as object in. If the target object is incompatible with object in, the
function returns an error and the data value of object out is of the same wire type as target
object.

• error out —

error out contains error information. This output provides standard error out functionality.

Use this function in VIs that meet the following criteria:

• The VI accepts a LabVIEW class as an input and returns the same LabVIEW class as
an output.
• You want to call the VI as a subVI.
• You want to guarantee that the output class type of the resulting subVI node
always changes to match the input class type when a child class is wired as an
input.

For many subVI nodes that accept and return the same LabVIEW class, LabVIEW
automatically downcasts the output class when you wire a child class to the class

© National Instruments 471


Functions

input. Those subVIs do not require you to use this function on their block diagram.

However, if it is impossible for LabVIEW to verify that the class type does not change
across the block diagram of the subVI, LabVIEW does not automatically downcast the
output class of the subVI node. In these cases, if you have additional knowledge that
guarantees that the class type does not change across the block diagram of the subVI,
you can use this function to downcast the class immediately before returning it from
the subVI. Because this function always returns an object of the same type as target
object, LabVIEW recognizes that it can downcast the returned class to that type.
Therefore, this function notifies LabVIEW that it is safe to downcast the class output of
the subVI node to match the input class type.

Related Information

Casting LabVIEW Classes

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Object-Oriented Programming\Preserve
Run-Time Class\Preserve Run-Time Class.lvproj

LV Object Constant

The LabVIEW Object is the common ancestor data type for all LabVIEW classes and
interfaces. You can use the LabVIEW Object to create generic methods that can handle
all LabVIEW class and interface data types.

Related Information

Creating a LabVIEW Class or Interface

472 ni.com
Functions

Get LV Class Default Value

Returns the class data for the class whose path you wire to the class path input. If the
class is not in memory, LabVIEW attempts to load it from disk. If any dependencies are
missing, LabVIEW searches for the missing dependencies. If LabVIEW cannot find the
dependency, LabVIEW assumes the dependency is missing and does not prompt the
user to browse to the needed file.

Use this VI to dynamically create class objects, including class objects that are
unknown at edit time.

Related Information

Creating a LabVIEW Class or Interface

Inputs/Outputs
• class path —

class path specifies the path to the LabVIEW class.

• options —

options is a bit set that specifies the behavior of LabVIEW when loading the class into memory.
The default is 0x0, which means that when loading the class, LabVIEW searches for missing
dependencies but does not prompt the user to browse to missing dependencies.

options can be a combination of the following values.

This option has no effect when loading LabVIEW classes. For VIs, this is the Record
Modifications value. When dynamically loading classes, modifications are always recorded
0x01 and may prompt you to save any unsaved changes when the class unloads. This behavior
has been true since classes were introduced in LabVIEW 8.2. This behavior might change in
a future version of LabVIEW.
0x02 This option has no effect when loading LabVIEW classes.

© National Instruments 473


Functions

0x04 This option has no effect when loading LabVIEW classes.


0x08 This option has no effect when loading LabVIEW classes.
0x10 Prompt user to find missing dependent VIs or libraries of the referenced class.
Do not display the loading dialog box when searching for missing dependencies.

0x20 Note This option does not affect whether LabVIEW prompts you to find the
missing dependencies or not.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• object —

object displays the data of the class wired to the class path input.

• error out —

error out contains error information. This output provides standard error out functionality.

Get LV Class Path

Returns the path to the class of the object.

Inputs/Outputs
• object —

object specifies the object for which you want to retrieve the path to the owning class.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

474 ni.com
Functions

• class path —

class path specifies the absolute path to the .lvclass file on disk. If an error occurs, the value
of class path is <Not A Path>. If object is a LabVIEW Object, which does not exist on disk, the
value of class path is <Empty Path>. If object belongs to a class that is not saved, class path is a
relative path consisting only of the name of the class.

• error out —

error out contains error information. This output provides standard error out functionality.

Get LV Class Default Value By Name

Returns the class data for the class whose name you wire to the class name input. If
the class is not in memory or is broken, LabVIEW returns an error.

Inputs/Outputs
• class name —

class name specifies the name of the class whose data you want to retrieve.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• object —

object returns the data of the class you wire to the class name input.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 475


Functions

Get LV Class Name

Returns the name of the class of the object.

Inputs/Outputs
• object —

object specifies the object for which you want to retrieve the name of the owning class.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• class name —

class name returns the class name of object.

• error out —

error out contains error information. This output provides standard error out functionality.

Variant

Use the Variant VIs and functions to add, retrieve, and delete attributes in LabVIEW
variants, manipulate variants, and retrieve data types of variants.

Palette Object Description


To Variant Converts any LabVIEW data to variant data. You also can use this function to
Function convert ActiveX data to variant data.
Variant To Data Converts variant data to a LabVIEW data type so LabVIEW can display or process

476 ni.com
Functions

Palette Object Description


Function the data. You also can use this function to convert variant data to ActiveX data.

Use the variant constant to pass an empty variant to the block diagram. You
Variant Constant
cannot set a value for the variant constant.

Flattened String
To Variant Converts flattened data into variant data.
Function
Variant To
Converts variant data into a flattened string and an array of integers that
Flattened String
represent the data type. You cannot flatten ActiveX variant data.
Function
Get Variant
Retrieves the names and values of all attributes or the value of a single
Attribute
attribute, depending on whether you wire the name parameter.
Function
Set Variant
Attribute Allows you to change or create an attribute and value for variant data.
Function
Delete Variant
Attribute Deletes an attribute(s) and value(s) in variant data.
Function

Data Type Use the Data Type Parsing VIs to retrieve and compare the data type stored in a
Parsing variant to other data types.

To Variant Function

Converts any LabVIEW data to variant data. You also can use this function to convert
ActiveX data to variant data.

Inputs/Outputs
• anything —

© National Instruments 477


Functions

anything is any LabVIEW data you want to convert. This parameter is polymorphic.

• variant —

variant is the resulting variant data.

If you use the To Variant and Variant to Data functions with LabVIEW classes consider
the following caveat.

Variants do not recognize inheritance hierarchies. For example, if you have child data
traveling on a parent class wire and you then wire the parent wire to a To Variant
function, the variant recognizes only the parent data type. If you wire a child data type
to the Variant to Data function to extract the child data, LabVIEW returns an error. You
must wire the parent to the Variant to Data function. Then use the To More Specific
function to retrieve the child class data.

Variant To Data Function

Converts variant data to a LabVIEW data type so LabVIEW can display or process the
data. You also can use this function to convert variant data to ActiveX data.

Inputs/Outputs
• type —

type specifies the LabVIEW data type of the data stored in variant.

If the data is an integer, you can coerce the data to another numeric representation, such as an
extended-precision, floating-point number.
• variant —

variant is the variant data you want to convert to the LabVIEW data type specified in type.

• error in —

478 ni.com
Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• data —

data is the variant changed to the data type specified by type. If variant could not be converted
to the data type specified, this data returns the default value for the data type.

• error out —

error out contains error information. This output provides standard error out functionality.

Using Variant to Data with ActiveX References

This function also serves the same purpose as the QueryInterface method of ActiveX.
To use the Variant to Data function to switch between interfaces of an ActiveX object,
first convert the automation refnum for the ActiveX object to a variant by using the To
Variant function. Wire the variant version of the refnum to the variant input of the
Variant to Data function. Then create another automation refnum and select the
desired interface as the ActiveX class for the refnum. Wire this new automation refnum
to the type input of the Variant to Data function. LabVIEW associates the specified
interface with the automation refnum returned by data.

Using Variant Conversion Functions with LabVIEW Classes

If you use the To Variant and Variant to Data functions with LabVIEW classes, note that
variants do not recognize inheritance hierarchies. For example, if you have child data
traveling on a parent class wire and you then wire the parent wire to a To Variant
function, the variant recognizes only the parent data type. If you wire a child data type
to the Variant to Data function to extract the child data, LabVIEW returns an error. You
must wire the parent to the Variant to Data function. Then use the To More Specific
function to retrieve the child class data.

Variant Constant

Use the variant constant to pass an empty variant to the block diagram. You cannot set
a value for the variant constant.

© National Instruments 479


Functions

Flattened String To Variant Function

Converts flattened data into variant data.

Use the Flatten to String function to produce data string and type string.

Inputs/Outputs
• type string —

type string is an array of numeric integers that identifies the data type of the flattened string if
the data type existed in LabVIEW 7.x or earlier.

• data string —

data string is the flattened data you want to convert to variant data.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• variant —

variant is the resulting variant data.

• error out —

error out contains error information. This output provides standard error out functionality.

Variant To Flattened String Function

Converts variant data into a flattened string and an array of integers that represent the

480 ni.com
Functions

data type. You cannot flatten ActiveX variant data.

Inputs/Outputs
• variant —

variant is the variant data you want converted to a string of flattened data.

• type string —

type string is an array of numeric integers that identifies the data type of the flattened string.

• data string —

data string is the resulting flattened data you converted from variant data.

If you use this function to flatten variant data, LabVIEW flattens only the variant and
discards all its contents, including attributes. However, if you use the Flatten To String
function, LabVIEW flattens the variant and all of its attributes.

Get Variant Attribute Function

Retrieves the names and values of all attributes or the value of a single attribute,
depending on whether you wire the name parameter.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• variant —

© National Instruments 481


Functions

variant is the variant data for which you want to retrieve an attribute(s) and value(s).

• name —

name is the name of the attribute whose value you want to retrieve.

Do not wire this parameter if you want to retrieve all the attributes associated with the specified
variant. If you wire name, the names output changes to a Boolean output found, the array
output values changes to an output called value of the same type as default value, and the
function searches for only the specified attribute.
• default value (empty variant) —

default value is a value and data type that you specify. If the function does not find the attribute
specified in name, it returns the default value.

If you wire default value, you must wire name.


• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• duplicate variant —

duplicate variant is the variant data you input in variant.

• names —

names returns a 1D array containing the names of all attributes associated with the variant.
LabVIEW sorts this array and arranges the array elements in ascending order using the same
algorithm as the Sort 1D Array function.

If you wire the name parameter, this output changes to a Boolean value found. found returns
TRUE if the function finds the attribute that you specify in name.
• values —

values returns a 1D array containing the values associated with each attribute of the specified
variant in variant format. The values in this array appear in the same order as their
corresponding names appear in the names output.

You must unflatten each attribute value to an appropriate data type. If you wire name, this
output changes to a single variant value. If the function does not find the attribute that you
specify in name, it returns the value passed to default value.
• error out —

482 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

This function has two modes of behavior depending on whether you wire the name
parameter. By default, the function returns the names of all attributes and their
corresponding values in 1D arrays. If you wire name, the names output changes to a
Boolean output found, the values output changes to a variant output value, and the
function searches for only the specified attribute. If the function does not find the
specified attribute(s), or if it cannot convert the attribute(s) to the default value, found
is FALSE, and value displays the contents of default value.

Set Variant Attribute Function

Allows you to change or create an attribute and value for variant data.

Inputs/Outputs
• variant —

variant is the variant data you want to create an attribute and value for or replace a value for.

• name —

name is the name of the attribute you want to edit or create. If name matches an attribute, this
function replaces the attribute with the value specified. If name does not match an attribute,
this function creates a new attribute. If name is an empty string, this function returns error code
1 because an empty string triggers a special behavior in the Delete Variant Attribute function.

• value —

value is the value of the attribute. This input is polymorphic, so you can wire any data to it.

• error in —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 483


Functions

standard error in functionality.

• variant out —

variant out is the variant data with new attributes.

• replaced —

replaced is TRUE if an attribute and value were replaced.

• error out —

error out contains error information. This output provides standard error out functionality.

Delete Variant Attribute Function

Deletes an attribute(s) and value(s) in variant data.

Inputs/Outputs
• variant —

variant is the variant data you want to delete an attribute(s) and value(s) in.

• name (all attributes) —

name is the name of the attribute you want to delete. If name matches an attribute, this function
deletes the attribute and its value. If name is an empty string, this function deletes all the
attributes and associated values in the variant data. The default is an empty string.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• variant out —

484 ni.com
Functions

variant out is the variant data with the deleted attribute(s).

• found —

found is TRUE if the function found the attribute specified in name.

If name is unwired, found is TRUE if the function located and deleted attributes and FALSE
otherwise.

• error out —

error out contains error information. This output provides standard error out functionality.

Data Type Parsing

Use the Data Type Parsing VIs to retrieve and compare the data type stored in a variant
to other data types.

Palette Object Description

Get Type
Retrieves data type information from the data type stored in variant.
Information

Get Array Retrieves array information from the data type stored in variant. This VI returns an
Information error if variant does not contain an array.

Get Cluster Retrieves cluster information from the data type stored in variant. This VI returns
Information an error if variant does not contain a cluster.

Is Error
Indicates whether the data type stored in variant is an error cluster.
Cluster

© National Instruments 485


Functions

Palette Object Description

Get Numeric Retrieves numeric information from the data type stored in variant. This VI returns
Information an error if variant does not contain a numeric.

Get Fixed-
Retrieves fixed-point numeric (FXP) information from the data type stored in
Point
variant. This VI returns an error if variant does not contain a fixed-point numeric.
Information

Get Waveform Retrieves waveform information from the data type stored in variant. This VI
Information returns an error if variant does not contain a waveform.

Get Channel Retrieves channel information from the data type stored in variant. This VI returns
Information an error if variant does not contain a channel.

Get Refnum Retrieves refnum information from the data type stored in variant. This VI returns
Information an error if variant does not contain a refnum.

Get User-
Defined Retrieves user-defined refnum information from the data type stored in variant.
Refnum This VI returns an error if variant does not contain a user-defined refnum.
Information

Get User-
Retrieves user-defined tag information from the data type stored in variant. This VI
Defined Tag
returns an error if variant does not contain a user-defined tag.
Information

Get Tag Returns the tag data type stored in variant. This VI returns an error if variant does
Information not contain a tag.

Retrieves VI information from the data type stored in variant. To obtain the
Get VI connector pane data type, read the Connector Pane:DataType property of the VI
Information class in VI Server. This VI returns an error if variant does not contain a connector
pane data type.

486 ni.com
Functions

Palette Object Description

Get
Retrieves polymorphic VI information from the data type stored in variant. This VI
Polymorphic
returns an error if variant does not contain a polymorphic VI.
VI Information

Get Map
Collection Retrieves map information from the data type stored in variant.
Information
Get Set
Collection Retrieves set information from the data type stored in variant.
Information
Get Type
Definition Returns the path to the type definition of the data type stored in variant.
Path

Is or Contains
Returns TRUE if the data type stored in variant is an instance of a type definition or
Type
contains a data type which is an instance of a type definition.
Definition

Disconnect
Returns the data type stored in variant in and removes all connections to type
Type
definitions from the data type.
Definitions

Check for
Contained Returns TRUE if variant contains the data type you specify.
Data Type

Get LabVIEW
Retrieves LabVIEW class information from the data type stored in variant. This VI
Class
returns an error if variant does not contain a LabVIEW class.
Information

Get LabVIEW Retrieves parent and member VI information of the LabVIEW class or interface
Class Parent stored in variant. This VI returns an error if variant does not contain a LabVIEW
And Member class or interface or if the LabVIEW class or interface is broken due to missing
VI Information parents or missing private data control dependencies.

© National Instruments 487


Functions

Get Type Information


Retrieves data type information from the data type stored in variant.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• type —

type returns the data type stored in variant.

• name —

name returns the name of the data type stored in variant.

• type definition —

type definition returns TRUE when the data type stored in variant is an instance of a type
definition.

Note To determine whether the data type in Variant is an instance of a type


definition or contains a data type which is an instance of a type definition, you also
can use the Is or Contains Type Definition VI.

• error out —

error out contains error information. This output provides standard error out functionality.

488 ni.com
Functions

• type definition info —

type definition info returns the type definition information only if type definition is TRUE.

• Name —

Name returns the name of the type definition.

• Timestamp —

Timestamp returns the timestamp of the last edit to the .ctl file if the data type stored in
Variant is an instance of a strict type definition. Otherwise, Timestamp returns 0.

Get Array Information


Retrieves array information from the data type stored in variant. This VI returns an
error if variant does not contain an array.

Note This VI does not return information about values stored in the array.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• number of dimensions —

© National Instruments 489


Functions

number of dimensions returns the dimensionality of the array stored in variant.

• array lengths —

array lengths returns the type and length of each dimension of the array stored in variant.

• Type —

Type returns the type for each dimension of the array stored in Variant.

Most arrays in LabVIEW are variable-sized arrays. Only certain domain-specific situations,
such as programming with the LabVIEW FPGA Module, use fixed-size arrays and bounded
arrays.

Variable—Indicates that the memory of the array dimension can grow or shrink as needed
0
to fit the data size.
Fixed—Indicates that the memory of the array dimension is pre-allocated and the data
1
length cannot change.
Bounded—Indicates that the memory of the array dimension has a maximum size and can
2
store data with length less than or equal to this size.

• Size —

Size returns the length of each dimension of the array stored in Variant. If Type is Variable,
Size returns 0. If Type is Fixed or Bounded, Size returns the number of elements in each
dimension of the array.

• array element data type —

array element data type returns the data type of elements of the array stored in variant.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Cluster Information


Retrieves cluster information from the data type stored in variant. This VI returns an
error if variant does not contain a cluster.

490 ni.com
Functions

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• cluster elements —

cluster elements returns an array which contains the data types of cluster elements stored in
variant.

• error out —

error out contains error information. This output provides standard error out functionality.

Is Error Cluster
Indicates whether the data type stored in variant is an error cluster.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

© National Instruments 491


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• is error cluster? —

is error cluster? returns TRUE if the data type stored in variant is an error cluster. Otherwise, this
output returns FALSE.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Numeric Information


Retrieves numeric information from the data type stored in variant. This VI returns an
error if variant does not contain a numeric.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• enum names —

enum names returns the enumerated values when the numeric data type stored in variant is an
enum.

• units —

492 ni.com
Functions

units returns the unit type and exponent when the numeric data type stored in variant has units.

• Unit Type —

• Exponent —

• representation —

representation returns the numeric representation of the data type stored in variant.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Fixed-Point Information


Retrieves fixed-point numeric (FXP) information from the data type stored in variant.
This VI returns an error if variant does not contain a fixed-point numeric.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• FXP representation —

FXP representation returns the fixed-point information from the fixed-point data type stored in

© National Instruments 493


Functions

variant.

• Signed —

Signed returns whether the fixed-point data type stored in Variant is signed.

• Word Length —

Word Length returns the number of bits that LabVIEW uses to represent all the possible
values of the fixed-point data type stored in Variant.

• Integer Word Length —

Integer Word Length returns the number of integer bits, or the number of bits to shift the
binary point to the left to reach the most significant bit, for all possible values of the fixed-
point data type stored in Variant.

• FXP range —

FXP range returns the range LabVIEW calculates for the fixed-point number stored in variant.

• Range Min —

Range Min returns the minimum value of the range of the fixed-point data type stored in
Variant.

• Range Max —

Range Max returns the maximum value of the range of the fixed-point data type stored in
Variant.

• Delta —

Delta returns the maximum distance between any two sequential numbers in the range of
the fixed-point data type stored in Variant.

• include overflow status? —

include overflow status? returns whether the fixed-point number in variant includes an
overflow status. If include overflow status? is TRUE, LabVIEW allocates additional storage space
to track whether the fixed-point number is the result of an operation that overflowed.

494 ni.com
Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Get Waveform Information


Retrieves waveform information from the data type stored in variant. This VI returns
an error if variant does not contain a waveform.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• Y array type —

Y array type returns the data type of the Y array element of the waveform stored in variant.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Channel Information


Retrieves channel information from the data type stored in variant. This VI returns an
error if variant does not contain a channel.

© National Instruments 495


Functions

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• forkable —

forkable returns whether the channel allows multiple writers or multiple readers.

• channel? —

channel? returns whether variant contains a channel. If channel? is FALSE, this VI returns an
error.

• template name —

template name returns the name of the template that the channel uses.

• element type —

element type returns the data type of the element that the channel carries.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Refnum Information


Retrieves refnum information from the data type stored in variant. This VI returns an
error if variant does not contain a refnum.

496 ni.com
Functions

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• reference type —

reference type returns the data type of the refnum stored in variant.

• strict type —

strict type returns the strict type of the refnum stored in variant. For example, a strictly-typed VI
refnum returns data type information that includes the connector pane of the VI.

• VI Server generic type —

VI Server generic type returns the specific VI Server class type. VI Server generic type is valid
only if reference type is LVObjUnknown.

• error out —

error out contains error information. This output provides standard error out functionality.

Get User-Defined Refnum Information


Retrieves user-defined refnum information from the data type stored in variant. This VI
returns an error if variant does not contain a user-defined refnum.

A user-defined refnum is a data type for system resources. One example of a user-
defined refnum is a DAQmx Task Name.

© National Instruments 497


Functions

Note The user-defined refnum data type is installed with some add-ons,
such as NI-DAQmx.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• class name —

class name returns the class name of the user-defined refnum stored in variant.

For example, a DAQmx Task Name returns a class name of Task.

• type name —

type name returns the type of the user-defined refnum stored in variant.

For example, a DAQmx Task Name returns a type name of NIDAQ.

• user data —

user data returns the internal information included with the user-defined refnum stored in
variant.

• error out —

error out contains error information. This output provides standard error out functionality.

498 ni.com
Functions

Get User-Defined Tag Information


Retrieves user-defined tag information from the data type stored in variant. This VI
returns an error if variant does not contain a user-defined tag.

A user-defined tag is a data type for system resources. A user-defined tag is allocated in
a static manner when a VI begins execution.

Note The user-defined tag data type is installed with some add-ons, such as
NI-RIO.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• class name —

class name returns the class name of the user-defined tag stored in variant.

For example, a RIO Device returns a class name of nirioResource.

• user data —

user data returns the internal information included with the user-defined tag stored in variant.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 499


Functions

Get Tag Information


Returns the tag data type stored in variant. This VI returns an error if variant does not
contain a tag.

A tag is a data type for system resources and is similar to a refnum. A tag is allocated in
a static manner when a VI begins execution, while a refnum is dynamically allocated.
One example of a tag is a DAQmx Device Name.

Note The tag data type is installed with some add-ons, such as NI-DAQmx.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• tag type —

tag type returns the tag data type.

For example, a DAQmx Device Name returns a tag type of kDAQmxDeviceTagType.

• error out —

error out contains error information. This output provides standard error out functionality.

500 ni.com
Functions

Get VI Information
Retrieves VI information from the data type stored in variant. To obtain the connector
pane data type, read the Connector Pane:DataType property of the VI class in VI Server.
This VI returns an error if variant does not contain a connector pane data type.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• thrall info —

thrall info returns the thrall information for each input and output in the VI. A LabVIEW class
output is thralled to a LabVIEW class input if LabVIEW determines that the output data type is
the same as the input data type. If, at run time, LabVIEW detects that an output is the same class
as, or is a child class of, an input, LabVIEW can downcast the LabVIEW class output so that the
output data type is the same as the input data type.

• Thralls —

Thralls returns an array which contains the indices to the LabVIEW class inputs that a
LabVIEW class output is thralled to. If a terminal is an input or a terminal is not thralled to
any LabVIEW class input, Thralls returns an empty array.

• VI info —

VI info returns the attributes related to the connector pane and other settings of the VI.

© National Instruments 501


Functions

• Connector Pane Pattern —

Connector Pane Pattern returns the index to the connector pane pattern of the VI. Refer to
the Connector Pane Pattern Reference VI located in the labview\examples\
Application Control\VI Scripting\Connector Pane directory for a list of
connector pane patterns and their indexes.

• Connector Pane Rotation —

Connector Pane Rotation returns a numeric value corresponding to the rotation of the
connector pane.

The following table contains the possible values for this output:

0 Indicates that the connector pane did not rotate.


1 Indicates that the connector pane rotated counter-clockwise by 90 degrees.
2 Indicates that the connector pane rotated counter-clockwise by 180 degrees.
3 Indicates that the connector pane rotated counter-clockwise by 270 degrees.

• Flags —

Flags returns flags of the VI. Flags contain additional information about a VI. Flags are useful
for National Instruments to diagnose bug reports from customers.

• Modification Date —

Modification Date returns the date when the VI was last modified.

• Asynchronous —

Asynchronous returns whether the VI pauses the execution until VIs on other threads finish
executing.

• Non-Function —

Non-Function returns whether the VI outputs depend on the system state. For example, if
the output constants in a VI cannot be constant folded even when all the VI inputs are
constants, Non-Function returns TRUE.

• Subroutine —

502 ni.com
Functions

Subroutine returns whether the VI enables the subroutine priority in the Execution page of
the VI Properties dialog box.

• SubSystem —

SubSystem returns whether the VI is a subVI for the LabVIEW Control Design and Simulation
Module that you can place only on a simulation diagram. SubSystem is valid only if you
have installed the Control Design and Simulation Module.

• VI terminal types —

VI terminal types returns the data types of the terminals in the VI.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Polymorphic VI Information


Retrieves polymorphic VI information from the data type stored in variant. This VI
returns an error if variant does not contain a polymorphic VI.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• time stamp —

© National Instruments 503


Functions

time stamp returns the time and date at which the polymorphic VI was last edited.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Map Collection Information


Retrieves map information from the data type stored in variant.

Note This VI does not return information about values stored in the map.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information. This VI
returns an error if variant does not contain a map.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• key data type —

key data type returns the data type of the keys in the map stored in variant.

• value data type —

value data type returns the data type of the values in the map stored in variant.

• error out —

504 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

Get Set Collection Information


Retrieves set information from the data type stored in variant.

Note This VI does not return information about values stored in the set.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information. This VI
returns an error if variant does not contain a set.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• element data type —

element data type returns the data type of the elements in the set stored in variant.

• error out —

error out contains error information. This output provides standard error out functionality.

Get Type Definition Path


Returns the path to the type definition of the data type stored in variant.

© National Instruments 505


Functions

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• type definition path —

type definition path returns the path to the type definition of the data type stored in variant
when the data type is an instance of a type definition. Otherwise, LabVIEW returns an empty
path.

• error out —

error out contains error information. This output provides standard error out functionality.

Is or Contains Type Definition


Returns TRUE if the data type stored in variant is an instance of a type definition or
contains a data type which is an instance of a type definition.

Note To determine whether the data type stored in variant is an instance of


a type definition, you also can use the Get Type Information VI and wire an
indicator to type definition.

506 ni.com
Functions

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• is or contains typedef —

is or contains typedef returns TRUE when the data type stored in variant is an instance of a type
definition or contains a data type which is an instance of a type definition.

• error out —

error out contains error information. This output provides standard error out functionality.

Disconnect Type Definitions


Returns the data type stored in variant in and removes all connections to type
definitions from the data type.

Inputs/Outputs
• variant in —

variant in specifies the variant data that you want to disconnect from type definitions.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• variant out —

© National Instruments 507


Functions

variant out returns the data type stored in variant in and removes all connections to type
definitions from the data type.

• error out —

error out contains error information. This output provides standard error out functionality.

Check for Contained Data Type


Returns TRUE if variant contains the data type you specify.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• data type to find —

data type to find specifies the data type for which you want to search within the data type
stored in variant.

• check inside refnums? (F) —

check inside refnums? specifies whether to compare the data type stored in a refnum to data
type to find.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• LabVIEW class qualified name ("") —

508 ni.com
Functions

LabVIEW class qualified name specifies the LabVIEW class name to compare to any LabVIEW
class stored in variant when data type to find is LabVIEW Class Instance. If LabVIEW class
qualified name is empty, contains data type to find? returns TRUE when variant contains any
LabVIEW classes.

• contains data type to find? —

contains data type to find? returns TRUE if variant contains data type to find. For example, if
variant is a cluster that contains a Boolean element and elements of other data types and data
type to find is Boolean, contains data type to find? returns TRUE.

• error out —

error out contains error information. This output provides standard error out functionality.

Get LabVIEW Class Information


Retrieves LabVIEW class information from the data type stored in variant. This VI
returns an error if variant does not contain a LabVIEW class.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• LabVIEW class file name —

LabVIEW class file name returns the name of the LabVIEW class file on disk.

• qualified LabVIEW class name —

© National Instruments 509


Functions

qualified LabVIEW class name returns an array that contains the LabVIEW class stored in
variant, the project library that owns the LabVIEW class, and any project libraries that own the
project library.

• error out —

error out contains error information. This output provides standard error out functionality.

Get LabVIEW Class Parent And Member VI


Information
Retrieves parent and member VI information of the LabVIEW class or interface stored in
variant. This VI returns an error if variant does not contain a LabVIEW class or interface
or if the LabVIEW class or interface is broken due to missing parents or missing private
data control dependencies.

Inputs/Outputs
• variant —

variant specifies the variant data from which you want to retrieve data type information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• parent class —

parent class returns the parent class of the LabVIEW class or interface.

• member VI info —

510 ni.com
Functions

member VI info returns the qualified name, path, access scope, and dynamic dispatch
information of all member VIs of the LabVIEW class or interface. Each array element represents
one member VI. The path is empty if the member VI has not been saved.

• qualified name —

• path —

• access scope —

• is dynamic dispatch —

• error out —

error out contains error information. This output provides standard error out functionality.

• parent interfaces —

parent interfaces returns the interfaces that the LabVIEW class or interface inherits from directly.

Numeric
Use the Numeric VIs and functions to create and perform arithmetic and complex
mathematical operations on numbers and to convert numbers from one data type to
another. Use the VIs and functions on the Elementary and Special Functions and VIs
palette to perform trigonometric and logarithmic functions.

You also can access the following constants from this palette:

• positive infinity
• negative infinity
• machine epsilon
• not a number

© National Instruments 511


Functions

Palette
Description
Object
Add
Computes the sum of the inputs.
Function
Subtract
Computes the difference of the inputs.
Function
Multiply
Returns the product of the inputs.
Function
Divide
Computes the quotient of the inputs.
Function
Quotient &
Computes the integer quotient and the remainder of the inputs. This function
Remainder
rounds floor(x/y) to the nearest integer towards -inf.
Function

Conversion Use the Conversion VIs and functions to convert data types.

Increment
Adds 1 to the input value.
Function
Decrement
Subtracts 1 from the input value.
Function
Add Array
Elements Returns the sum of all the elements in numeric array.
Function
Multiply
Returns the product of all the elements in numeric array. If numeric array is an
Array
empty array, the function returns a value of 1. If numeric array contains only one
Elements
element, the function returns that element.
Function
Performs arithmetic on one or more numeric, array, cluster, or Boolean inputs. To
select the operation (Add, Multiply, AND, OR, or XOR), right-click the function and
Compound
select Change Mode from the shortcut menu. When you select this function from the
Arithmetic
Numeric palette, the default mode is Add. When you select this function from the
Boolean palette, the default mode is OR.

Data
Use the Data Manipulation functions to modify the data types used in LabVIEW.
Manipulation

Absolute Returns the absolute value of the input.

512 ni.com
Functions

Palette
Description
Object
Value
Function
Round To
Rounds the input to the nearest integer. If the value of the input is midway between
Nearest
two integers, the function returns the nearest even integer.
Function
Round
Toward
Truncates the input to the next lowest integer.
-Infinity
Function
Round
Toward
Rounds the input to the next highest integer.
+Infinity
Function
Scale By
Power Of 2 Multiplies x by 2 raised to the power of n.
Function

Use the Complex functions to create complex numbers from two values given in
Complex rectangular or polar and to break a complex number into its rectangular or polar
components.

Square Root
Computes the square root of the input value.
Function
Square
Computes the square of the input value.
Function
Negate
Negates the input value.
Function
Reciprocal
Divides 1 by the input value.
Function
Sign
Returns the sign of number.
Function

Scaling Use the Scaling VIs to convert voltage readings to other temperature or strain units.

© National Instruments 513


Functions

Palette
Description
Object
Numeric Use the numeric constant to pass a numeric value to the block diagram. Set this
Constant value by clicking inside the constant with the Operating tool and typing a value.
Enum Use the enumerated constant to create a list of string labels with corresponding
Constant integer values you can select on the block diagram.
Ring Use the ring constant to create a list of value pairs you can select on the block
Constant diagram. Each value pair consists of a numeric value and corresponding string label.
Random
Produces a double-precision, floating-point number between 0 and 1. The number
Number (0-1)
generated is greater than or equal to 0, but less than 1. The distribution is uniform.
Function

Random Generates a random value from a specified range. Wire data to the upper bound or
Number lower bound input to determine the polymorphic instance to use or manually select
(Range) the instance.

Use the Fixed-Point functions to manipulate the overflow status of a fixed-point


Fixed-Point
number.

Use the DBL numeric constant to pass a double-precision, floating-point numeric


DBL Numeric
value to the block diagram. Set this value by clicking inside the constant with the
Constant
Operating tool and typing a value.

Positive
Returns the value Inf (infinity).
Infinity
Negative
Returns the value -Inf (negative infinity).
Infinity
Represents the round-off error for a floating-point number with a given precision.
Machine
Use the machine epsilon constant to compare whether two floating-point numbers
Epsilon
are equivalent.
Not A
Number Returns the value NaN (not a number).
Constant

514 ni.com
Functions

Palette
Description
Object
Math &
Scientific Use the Math & Scientific Constants to create LabVIEW applications.
Constants

Range Limits
Returns the maximum and minimum values of the input data type.
for Type

Use the Expression Node to calculate expressions that contain a single variable. The
following built-in functions are allowed in formulas: abs, acos, acosh, asin, asinh,
Expression
atan, atanh, ceil, cos, cosh, cot, csc, exp, expm1, floor, getexp, getman, int, intrz, ln,
Node
lnp1, log, log2, max, min, mod, rand, rem, sec, sign, sin, sinc, sinh, sizeOfDim, sqrt,
tan, tanh.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Add Function

Computes the sum of the inputs.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• y—

y can be a scalar number, a fixed-point number, an array or cluster of numbers, an array of


clusters of numbers, a time stamp, and so on.

• x+y —

© National Instruments 515


Functions

x+y is the sum of x and y.

Note You can manually configure this function to output data of a type you want. To
specify the output data type, right-click the function and select Properties to display
the Object Properties dialog box. On the Output Configuration page, click the
Representation icon and select the data type you want. A blue coercion dot appears
on the output terminal of the function to indicate that you have configured the
output data type.

Matrix Details

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the inputs. Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns a NaN.

You also can add two or more values using the Compound Arithmetic function.

Fixed-Point Details

If you wire fixed-point values to Numeric functions such as Add, Subtract, Multiply, and
Square, the functions usually return values that do not lose any bits of word length.
However, if the operation creates a value that exceeds the maximum word length that
LabVIEW accepts, overflow or rounding conditions can occur. LabVIEW accepts a
maximum word length of 64 bits. Use the Numeric Node Properties dialog box to
configure how LabVIEW handles overflow or rounding of fixed-point data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

516 ni.com
Functions

Subtract Function

Computes the difference of the inputs.

If you wire two waveform values or two dynamic data type values to this function,
error in and error out terminals appear on the function. Subtracting two time stamp
values yields a numeric value (difference in time), and subtracting a numeric value
from a time stamp value yields a time stamp. You cannot subtract a time stamp value
from a numeric value. The dimensions of two matrices that you want to subtract must
be the same. Otherwise, this function returns an empty matrix. The connector pane
displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x specifies the input value.

This input accepts the following data types:


• Number
• Timestamp
• Analog Waveform
This input also accepts an array or an array of clusters of the listed data types.
• y—

y can be a scalar number, a fixed-point number, an array or cluster of numbers, an array of


clusters of numbers, a time stamp, and so on.

• x-y —

x-y is the difference between x and y.

Note You can manually configure this function to output data of a type you want. To
specify the output data type, right-click the function and select Properties to display
the Object Properties dialog box. On the Output Configuration page, click the
Representation icon and select the data type you want. A blue coercion dot appears

© National Instruments 517


Functions

on the output terminal of the function to indicate that you have configured the
output data type.

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

Fixed-Point Details

If you wire fixed-point values to Numeric functions such as Add, Subtract, Multiply, and
Square, the functions usually return values that do not lose any bits of word length.
However, if the operation creates a value that exceeds the maximum word length that
LabVIEW accepts, overflow or rounding conditions can occur. LabVIEW accepts a
maximum word length of 64 bits. Use the Numeric Node Properties dialog box to
configure how LabVIEW handles overflow or rounding of fixed-point data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Multiply Function

Returns the product of the inputs.

If you wire two waveform values or two dynamic data type values to this function,
error in and error out terminals appear on the function. The connector pane displays
the default data types for this polymorphic function.

518 ni.com
Functions

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• y—

y can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• x*y —

x*y is the product of x multiplied by y.

You cannot use this function to multiply a matrix and a vector. Use the A x B VI instead.

When multiplying two matrices, if the number of rows in the second matrix does not
match the number of columns in the first matrix, this function returns an empty
matrix. Refer to the A x B VI for more information about matrix multiplication.

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

Fixed-Point Details

If you wire fixed-point values to Numeric functions such as Add, Subtract, Multiply, and
Square, the functions usually return values that do not lose any bits of word length.
However, if the operation creates a value that exceeds the maximum word length that
LabVIEW accepts, overflow or rounding conditions can occur. LabVIEW accepts a
maximum word length of 64 bits. Use the Numeric Node Properties dialog box to
configure how LabVIEW handles overflow or rounding of fixed-point data.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 519


Functions

• labview\examples\Numerics\Numeric Functions.vi

Divide Function

Computes the quotient of the inputs.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• y—

y can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• x/y —

x/y is a double-precision, floating-point number if both x and y are integers. In general, the
output type is the widest representation of the inputs if the inputs are not integers or if their
representations differ.

Note You can manually configure this function to output data of a type you want. To
specify the output data type, right-click the function and select Properties to display
the Object Properties dialog box. On the Output Configuration page, click the
Representation icon and select the data type you want. A blue coercion dot appears
on the output terminal of the function to indicate that you have configured the
output data type.

Fixed-Point Details

If you wire fixed-point values to this function, by default LabVIEW configures the
integer word length of the quotient to avoid overflow for nonzero values of y. However,
because the precision of the quotient can be infinite, rounding conditions always
occur. Use the Numeric Node Properties dialog box to configure how LabVIEW handles
rounding of fixed-point data. This function always uses the Saturate overflow mode to

520 ni.com
Functions

handle overflow.

Quotient & Remainder Function

Computes the integer quotient and the remainder of the inputs. This function rounds
floor(x/y) to the nearest integer towards -inf.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• y—

y can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• x-y*floor(x/y) —

x-y*floor(x/y) is the remainder.

This corresponds to the modulo function of text-based programming languages. When y is 1,


the remainder is the fractional part of x.

• floor(x/y) —

floor(x/y) is the integer quotient. If either input is a floating-point number, the quotient is a
floating-point number with an integer value.

When y is 1, the quotient is the integer part of x.

If the integer input value of y is zero, the quotient is zero and remainder is dividend x.
For floating-point inputs, if y is zero, the quotient is infinity and the remainder defaults
to NaN.

© National Instruments 521


Functions

Note Not all real numbers can be represented in the ANSI/IEEE standard
floating-point numbers. Because of this, LabVIEW may encounter rounding
errors and yield unexpected results if you use floating-point numbers with
this function. For exact calculations and comparisons, convert floating-point
numbers to integers.

Conversion

Use the Conversion VIs and functions to convert data types.

When these functions convert a floating-point number to an integer, they round the
output to the nearest integer, or the nearest even integer if the fractional part is 0.5. If
the result is out of range for the integer, these functions return the minimum or
maximum value for the integer type. When these functions convert an integer to a
smaller integer, they copy the least-significant bits without checking for overflow.
When they convert an integer to a larger integer, they extend the sign of a signed
integer and pad an unsigned integer with zeros.

Use caution when you convert numbers to smaller representations, particularly when
converting integers, because the LabVIEW conversion routines do not check for
overflow.

Palette
Description
Object
To
Extended
Precision Converts a number to an extended-precision, floating-point number.
Float
Function
To
Double
Precision Converts a number to a double-precision, floating-point number.
Float
Function

522 ni.com
Functions

Palette
Description
Object
To Single
Precision
Converts a number to a single-precision, floating-point number.
Float
Function
To Fixed-
Point Converts any non-complex number to fixed-point representation.
Function
To Quad
Integer Converts a number to a 64-bit integer in the range -(2^63) to (2^63)-1.
Function
To Long
Converts a number to a 32-bit integer in the range -(2^ 31) to (2^ 31)-1. This function
Integer
rounds all floating-point and fixed-point numeric values to the nearest integer.
Function
To Word
Integer Converts a number to a 16-bit integer in the range -32,768 to 32,767.
Function
To Byte
Integer Converts a number to an 8-bit integer in the range -128 to 127.
Function
To
Unsigned
Quad Converts a number to a 64-bit unsigned integer in the range 0 to (2^64)-1.
Integer
Function
To
Unsigned
Long Converts a number to a 32-bit unsigned integer in the range 0 to (2^32)-1.
Integer
Function
To
Unsigned
Word Converts a number to a 16-bit unsigned integer in the range 0 to 65,535.
Integer
Function
To
Converts a number to an 8-bit unsigned integer in the range 0 to 255.
Unsigned

© National Instruments 523


Functions

Palette
Description
Object
Byte
Integer
Function
To
Extended
Precision Converts a number to an extended-precision, complex number.
Complex
Function
To
Double
Precision Converts a number to a double-precision, complex number.
Complex
Function
To Single
Precision
Converts a number to a single-precision, complex number.
Complex
Function
Coerce
Converts the input data to a compatible data type while preserving the data value.
To Type
Unlike the Type Cast function, this function does not reinterpret the input data.
Function
Converts an integer or fixed-point number to a Boolean array. If you wire an integer to
Number
number, Boolean array returns an array of 8, 16, 32, or 64 elements, depending on the
To
number of bits in the integer. If you wire a fixed-point number to number, the size of the
Boolean
array that Boolean array returns equals the word length of the fixed-point number. The
Array
0th element of the array corresponds to the least significant bit of the two's complement
Function
representation of the integer.
Boolean
Converts a Boolean array to an integer or a fixed-point number by interpreting the array
Array To
as the binary representation of the number. The first element of the array corresponds
Number
to the least significant bit in the number.
Function
Boolean
Converts a Boolean FALSE or TRUE value to a 16-bit integer with a value of 0 or 1,
To (0,1)
respectively.
Function
To Time
Stamp Converts a number to a timestamp.
Function

524 ni.com
Functions

Palette
Description
Object
String To
Byte
Converts a string into an array of unsigned bytes.
Array
Function
Byte
Array To
Converts an array of unsigned bytes representing ASCII characters into a string.
String
Function
Converts a physical number (a number that has a unit) to a pure number (a number with
Convert
no units) or a pure number to a physical number. Right-click the function and select
Unit
Build Unit String from the shortcut menu to build and edit a string of units.
Cast Unit
Changes the base units associated with the input to the base units associated with unit
Bases
and returns the results at the output terminal.
Function

Color to Resolves any color input, including system colors, into its respective red, green, and blue
RGB components.

RGB to
Converts a red, green, and blue value from 0 to 255 to the corresponding RGB color.
Color

Enum to
Array of Creates an array of enums with the same number of elements as values in the enum.
Enums

To Extended Precision Float Function

Converts a number to an extended-precision, floating-point number.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 525


Functions

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• extended precision float —

extended precision float is of the same data type structure as number.

To Double Precision Float Function

Converts a number to a double-precision, floating-point number.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, a time
stamp, and so on.

• double precision float —

double precision float is of the same data type structure as number.

To Single Precision Float Function

Converts a number to a single-precision, floating-point number.

The connector pane displays the default data types for this polymorphic function.

526 ni.com
Functions

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• single precision float —

single precision float is of the same data type structure as number.

To Fixed-Point Function

Converts any non-complex number to fixed-point representation.

If you do not wire a value to the fixed-point type input or configure the output settings
of this function, the data type of the fixed-point output adapts to the data you wire to
the number input. For example, if you wire an 8-bit unsigned integer to the number
input, LabVIEW returns an 8-bit unsigned fixed-point number with 8 integer bits. This
function saturates the number by default if overflow occurs.

Inputs/Outputs
• fixed-point type —

fixed-point type is the fixed-point data type to which you want to convert the integer data. You
can configure the fixed-point data type in the Data Type page of the Properties dialog box.
LabVIEW ignores any data in the constant or control that you wire to fixed-point type. You also
can leave this input unwired and configure the output data type in the Output Configuration
page of the Properties dialog box.

• number —

© National Instruments 527


Functions

number can be any non-complex number.

• fixed-point —

fixed-point is the input data scaled to the requested fixed-point data type.

To override the default behavior of this function, right-click the function and select
Properties from the shortcut menu to display the Output Configuration page of the
Properties dialog box. You can use this dialog box to configure the output settings of
this function.

To Quad Integer Function

Converts a number to a 64-bit integer in the range -(2^63) to (2^63)-1.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, a time
stamp, and so on.

• 64bit integer —

64bit integer is of the same data type structure as number.

This function rounds all floating-point and fixed-point numeric values to the nearest
integer. If the fractional part of the value is .5, the function rounds the value to the
nearest even integer. For example, the function rounds 13.5 to 14 and rounds 14.5
to 14.

528 ni.com
Functions

To Long Integer Function

Converts a number to a 32-bit integer in the range -(2^ 31) to (2^ 31)-1. This function
rounds all floating-point and fixed-point numeric values to the nearest integer.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• 32bit integer —

32bit integer is of the same data type structure as number.

If the fractional part of the floating-point or fixed-point value is .5, the function
rounds the value to the nearest even integer. For example, the function rounds 13.5
to 14 and rounds 14.5 to 14.

To Word Integer Function

Converts a number to a 16-bit integer in the range -32,768 to 32,767.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

© National Instruments 529


Functions

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• 16bit integer —

16bit integer is of the same data type structure as number.

This function rounds all floating-point and fixed-point numeric values to the nearest
integer. If the fractional part of the value is .5, the function rounds the value to the
nearest even integer. For example, the function rounds 13.5 to 14 and rounds 14.5
to 14.

To Byte Integer Function

Converts a number to an 8-bit integer in the range -128 to 127.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• 8bit integer —

8bit integer is of the same data type structure as number.

This function rounds all floating-point numeric values to the nearest integer. If the
fractional part of the floating-point value is .5, the function rounds the value to the
nearest even integer. For example, the function rounds 13.5 to 14 and rounds 14.5
to 14.

530 ni.com
Functions

To Unsigned Quad Integer Function

Converts a number to a 64-bit unsigned integer in the range 0 to (2^64)-1.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, a time
stamp, and so on.

• unsigned 64bit integer —

unsigned 64bit integer is of the same data type structure as number.

This function rounds all floating-point and fixed-point numeric values to the nearest
integer. If the fractional part of the value is .5, the function rounds the value to the
nearest even integer. For example, the function rounds 13.5 to 14 and rounds 14.5
to 14.

To Unsigned Long Integer Function

Converts a number to a 32-bit unsigned integer in the range 0 to (2^32)-1.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

© National Instruments 531


Functions

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, a time
stamp, and so on.

• unsigned 32bit integer —

unsigned 32bit integer is of the same data type structure as number.

This function rounds all floating-point and fixed-point numeric values to the nearest
integer. If the fractional part of the value is .5, the function rounds the value to the
nearest even integer. For example, the function rounds 13.5 to 14 and rounds 14.5
to 14.

To Unsigned Word Integer Function

Converts a number to a 16-bit unsigned integer in the range 0 to 65,535.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• unsigned 16bit integer —

unsigned 16bit integer is of the same data type structure as number.

This function rounds all floating-point and fixed-point numeric values to the nearest
integer. If the fractional part of the value is .5, the function rounds the value to the
nearest even integer. For example, the function rounds 13.5 to 14 and rounds 14.5
to 14.

532 ni.com
Functions

To Unsigned Byte Integer Function

Converts a number to an 8-bit unsigned integer in the range 0 to 255.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• unsigned 8bit integer —

unsigned 8bit integer is of the same data type structure as number.

This function rounds all floating-point and fixed-point numeric values to the nearest
integer. If the fractional part of the value is .5, the function rounds the value to the
nearest even integer. For example, the function rounds 13.5 to 14 and rounds 14.5
to 14.

To Extended Precision Complex Function

Converts a number to an extended-precision, complex number.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

© National Instruments 533


Functions

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• extended precision complex —

extended precision complex is of the same data type structure as number.

To Double Precision Complex Function

Converts a number to a double-precision, complex number.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• double precision complex —

double precision complex is of the same data type structure as number.

To Single Precision Complex Function

Converts a number to a single-precision, complex number.

The connector pane displays the default data types for this polymorphic function.

534 ni.com
Functions

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• single precision complex —

single precision complex is of the same data type structure as number.

Coerce To Type Function

Converts the input data to a compatible data type while preserving the data value.
Unlike the Type Cast function, this function does not reinterpret the input data.

Use this function in the following cases:

• To eliminate a coercion dot


• To convert data without a type definition to a compatible type definition or vice
versa
• To rename data on the wire, such as a user event refnum

Inputs/Outputs
• type —

type specifies the data type to which you want to convert the input data x.

To set the data type to which you want to convert the input data, wire a constant or control of
the desired data type to type. LabVIEW ignores any data in the constant or control wired to type.

• x—

x specifies the data you want to convert.

© National Instruments 535


Functions

This input accepts any data type.

• coerced x —

coerced x returns the value of the input data x after the conversion.

The Type Cast function also converts data to a desired data type. Unlike the Type Cast
function, the Coerce To Type function allows only conversion between compatible
data types to preserve the value of the input data, similar to what a coercion dot does.
The Type Cast function allows conversion between incompatible data types by
flattening and unflattening the input data, which allows for radical reinterpretation of
the data. When the desired data type requires a different memory size than the input
data, the Type Cast function may reinterpret the input data. NI recommends that you
use the Coerce To Type function instead of the Type Cast function to avoid
reinterpreting the data.

Number To Boolean Array Function

Converts an integer or fixed-point number to a Boolean array. If you wire an integer to


number, Boolean array returns an array of 8, 16, 32, or 64 elements, depending on the
number of bits in the integer. If you wire a fixed-point number to number, the size of
the array that Boolean array returns equals the word length of the fixed-point number.
The 0th element of the array corresponds to the least significant bit of the two's
complement representation of the integer.

Inputs/Outputs
• number —

number can be a number.

• Boolean array —

Boolean array can have 8, 16, 32, or 64 elements if number is an integer. If number is a fixed-

536 ni.com
Functions

point number, Boolean array can have between 1 and 64 elements.

If you wire a fixed-point number that includes an overflow status to number, this
function ignores the overflow status and converts only the number to a Boolean array.

Boolean Array To Number Function

Converts a Boolean array to an integer or a fixed-point number by interpreting the


array as the binary representation of the number. The first element of the array
corresponds to the least significant bit in the number.

Inputs/Outputs
• Boolean array —

Boolean array is a one-dimensional array of Boolean values.

This function truncates Boolean array if it is too long. If Boolean array is too short, this function
pads Boolean array according to the Sign Extension Mode you can select by right-clicking the
function.

• Never —This function pads Boolean array with Boolean FALSE bits.
• If Output Is Signed —(default) For an output with an unsigned representation, this function
pads Boolean array with Boolean FALSE bits. For an output with a signed representation,
this function pads Boolean array with the last element of the array.
• Always —This function pads Boolean array with the last element of the array.
• number —

number is an integer or a fixed-point number.

You can change the numeric representation of number on the Output Configuration page of the
Properties dialog box. Right-click the function and select Properties to display the Properties
dialog box.

The following table shows the relationship between Boolean array and number.

© National Instruments 537


Functions

Output Sign Extension Binary


Boolean array number
Representation Mode Value
{FALSE, TRUE} I8 If Output Is Signed 11111110 -2
{FALSE, TRUE} U8 If Output Is Signed 00000010 2
{FALSE, TRUE, FALSE, TRUE} I8 Always 11111010 -6
{FALSE, TRUE, FALSE, TRUE} I8 Never 00001010 10
{FALSE, FALSE, TRUE, FALSE,
U8 If Output Is Signed 00010100 20
TRUE}
{FALSE, FALSE, TRUE, FALSE,
U8 Always 11110100 244
TRUE}

Boolean To (0,1) Function

Converts a Boolean FALSE or TRUE value to a 16-bit integer with a value of 0 or 1,


respectively.

Inputs/Outputs
• Boolean —

Boolean can be a scalar, an array, a cluster of Boolean values, an array of clusters of Boolean
values, and so on. If Boolean is an error cluster, only the status parameter of the error cluster
passes to the input terminal.

• 0, 1 —

0, 1 is 0 if Boolean is FALSE and 1 if Boolean is TRUE.

To Time Stamp Function

Converts a number to a timestamp.

538 ni.com
Functions

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on, that represents the amount of seconds from the epoch time of 12 a.m., January 1, 1904
[01-01-1904 00:00:00].

• time stamp —

time stamp is a time-zone-independent number of seconds that have elapsed since 12:00 a.m.,
Friday, January 1, 1904, Universal Time [01-01-1904 00:00:00].

String To Byte Array Function

Converts a string into an array of unsigned bytes.

Each byte in the array has the ASCII value of the corresponding character in the string.

Inputs/Outputs
• string —

string is the input string the function converts.

• unsigned byte array —

unsigned byte array is the output array.

The first byte in the array has the ASCII value of the first character in string, the second byte has
the second value, and so on.

Byte Array To String Function

Converts an array of unsigned bytes representing ASCII characters into a string.

© National Instruments 539


Functions

Inputs/Outputs
• unsigned byte array —

unsigned byte array is the array of ASCII values you want to convert.

• string —

string is the result of interpreting each array element as an ASCII value and forming a string out
of the corresponding characters.

Refer to ASCII Codes for the numbers that correspond to each character.

Convert Unit

Converts a physical number (a number that has a unit) to a pure number (a number
with no units) or a pure number to a physical number. Right-click the function and
select Build Unit String from the shortcut menu to build and edit a string of units.

Inputs/Outputs
• —

x is a floating-point number with or without a unit.

• —

y is a floating-point number that has a unit if x does not have a unit. y does not have a unit if x
does have a unit.

Edit the unit string by using the Labeling or Operating tool to highlight the string and
entering a new string. You also can right-click the function and select Build Unit String
from the shortcut menu to display the Build Unit String dialog box. The unit you enter

540 ni.com
Functions

must be a unit available in LabVIEW.

If the input is a physical number measured in a compatible unit, the output is a pure
number measured in the unit specified. For example, if x is 37 meters (m), and you
enter m (meters) as the unit in the Convert Unit function, y is 37 with no associated
units. If x is 37 meters and you enter ft (feet) as the unit in the Convert Unit function, y
is 121.36 with no associated units.

If the input is a pure number, LabVIEW assigns the unit you specify in the Convert Unit
function to the number and returns that physical number in the base unit (or a
combination of base units) for that class of measurement, as indicated in the following
table.

Class Base Unit Abbreviation


amount of substance mole mol
angle (plane) radian rad
angle (solid) steradian sr
electric current ampere A
length meter m
luminous intensity candela cd
mass kilogram kg
temperature (thermodynamic) kelvin K
time second s

For example, if x is 10 and you enter s (seconds) as the unit in the Convert Unit
function, y is 10 seconds because seconds is the base unit LabVIEW uses to measure
time. If x is 10 and you enter min (minutes) as the unit in the Convert Unit function, y is
600 seconds. You then can change the unit the indicator displays to show minutes,
hours, or any other unit of time.

Cast Unit Bases Function

Changes the base units associated with the input to the base units associated with
unit and returns the results at the output terminal.

© National Instruments 541


Functions

Caution Use this function with extreme caution. Because this function
works with bases, you must understand the conversion from an arbitrary unit
to its bases before you can effectively use this function. This function can
change base units, such as changing meters to kilograms.

Inputs/Outputs
• unit (none) —

unit associates input with output results.

The default is none, which does not associate any units.

• x—

x is a floating-point number with or without a unit.

• x—

x returns the same data type and structure as x.

Wiring unit to a constant of units mm is no different than wiring to a constant of units m


because the base unit (m) is identical. In most instances, use the Convert Unit function
to turn the units feature on or off or to convert between units.

Color to RGB

Resolves any color input, including system colors, into its respective red, green, and
blue components.

To perform a task such as color arithmetic with symbolic colors, you must convert the
colors to their red, green, and blue components.

542 ni.com
Functions

Inputs/Outputs
• Color —

Color is the color that you want to convert to its respective red, green, and blue components.

• Resolved Color —

resolved color is the resolved color in RGB format.

• R—

R is the red component of the RGB value, 0 to 255.

• G—

G is the green component of the RGB value, 0 to 255.

• B—

B is the blue component of the RGB value, 0 to 255.

RGB to Color

Converts a red, green, and blue value from 0 to 255 to the corresponding RGB color.

Inputs/Outputs
• R—

R is the red value for the color, 0 to 255.

• G—

© National Instruments 543


Functions

G is the green value for the color, 0 to 255.

• B—

B is the blue value for the color, 0 to 255.

• Color —

Color is the RGB color value that corresponds to R, G, and B.

Enum to Array of Enums

Creates an array of enums with the same number of elements as values in the enum.

Inputs/Outputs
• enum —

enum specifies the input enum.

• array of enums —

array of enums returns an array containing each enum value in order.

For example, if enum has values {cat, dog, bird}, array of enums returns a three-element array
with values cat, dog, and bird, respectively.

Increment Function

Adds 1 to the input value.

The connector pane displays the default data types for this polymorphic function.

544 ni.com
Functions

Inputs/Outputs
• x—

x specifies the input value.

This input accepts the following data types:

• Number
• Timestamp
• Analog Waveform

This input also accepts an array or an array of clusters of the listed data types.

• x+1 —

x+1 is the result of x+1. If the input is a time stamp value, this function increments the time by
one second. If the input is an enumerated type value, this function increments the last
enumerated value to the first.

Note You can manually configure this function to output data of a type you want. To
specify the output data type, right-click the function and select Properties to display
the Object Properties dialog box. On the Output Configuration page, click the
Representation icon and select the data type you want. A blue coercion dot appears
on the output terminal of the function to indicate that you have configured the
output data type.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Decrement Function

Subtracts 1 from the input value.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 545


Functions

Inputs/Outputs
• x—

x specifies the input value.

This input accepts the following data types:

• Number
• Timestamp
• Analog Waveform

This input also accepts an array or an array of clusters of the listed data types.

• x-1 —

x-1 is the result of x-1. If the input is a time stamp value, this function decrements the time by
one second. If the input is an enumerated type value, this function decrements the first
enumerated value to the last.

Note You can manually configure this function to output data of a type you want. To
specify the output data type, right-click the function and select Properties to display
the Object Properties dialog box. On the Output Configuration page, click the
Representation icon and select the data type you want. A blue coercion dot appears
on the output terminal of the function to indicate that you have configured the
output data type.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Add Array Elements Function

Returns the sum of all the elements in numeric array.

546 ni.com
Functions

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• numeric array —

numeric array can have any number of dimensions.

• sum —

sum is of the same data type and structure as the elements in numeric array.

Note You cannot use this function with fixed-point numbers. If you wire
fixed-point numbers to this function, the VI appears with a broken Run
button.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Multiply Array Elements Function

Returns the product of all the elements in numeric array. If numeric array is an empty
array, the function returns a value of 1. If numeric array contains only one element, the
function returns that element.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 547


Functions

Inputs/Outputs
• numeric array —

numeric array can have any number of dimensions.

• product —

product is of the same data type and structure as the elements in numeric array.

Note You cannot use this function with fixed-point numbers. If you wire
fixed-point numbers to this function, the VI appears with a broken Run
button.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Compound Arithmetic

Performs arithmetic on one or more numeric, array, cluster, or Boolean inputs. To


select the operation (Add, Multiply, AND, OR, or XOR), right-click the function and
select Change Mode from the shortcut menu. When you select this function from the
Numeric palette, the default mode is Add. When you select this function from the
Boolean palette, the default mode is OR.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• value —

548 ni.com
Functions

value 0..n-1 can be a number or Boolean value, an array of numbers or Boolean values, a cluster,
array of clusters, and so on.

You can wire a waveform to only one value input. If an input is a waveform, you can have an
unlimited number of scalar inputs of varying sizes. If value is an error cluster, only the status
parameter of the error cluster passes to the input terminal.

• value —

• result —

result returns the result of the selected operation applied to the value 0..n-1. For AND, OR, or
XOR, result returns the bitwise operations on numeric inputs and logical operations on Boolean
inputs.

Add inputs to the node by right-clicking an input and selecting Add Input from the
shortcut menu or by resizing the function.

You can invert the inputs or the output of this function by right-clicking the individual
terminals and selecting Invert from the shortcut menu. For Add, select Invert to
negate an input or the output. For Multiply, select Invert to use the reciprocal of an
input or to produce the reciprocal of the output. For AND, OR, or XOR, select Invert to
bitwise complement an integer input or output or to logically negate an input or
output.

When you use the Compound Arithmetic function to perform an XOR operation on 3 or
more values, the Compound Arithmetic function performs an XOR operation on the
first pair of inputs, then performs an XOR operation on the result of the first pair of
inputs and the next input, and so on until all inputs have been processed.

Note You cannot use this function with fixed-point numbers. If you wire
fixed-point numbers to this function, the VI appears with a broken Run
button.

Data Manipulation

Use the Data Manipulation functions to modify the data types used in LabVIEW.

© National Instruments 549


Functions

Palette
Description
Object
Casts x to the data type, type, by flattening it and unflattening it using the new data
Type Cast type. If the function must reinterpret data instead of transforming it, LabVIEW uses a
Function temporary buffer. This function has the risk of reinterpreting data. To preserve the data
value while converting the data, use the Coerce To Type function instead.
Flatten To Converts the anything input to a flattened data string of binary values. You also can use
String this function to convert the byte order, or endian format, of the data in the flattened
Function data string.
Unflatten
Converts binary string to the type wired to type. binary string should contain flattened
From
data of the type wired to type. You also can use this function to specify the byte order,
String
or endian format, of the data in the binary string.
Function
Mantissa
& Returns the mantissa and exponent of the input numeric value such that number =
Exponent mantissa * 2^exponent.
Function
Rotate
Left With Rotates each bit in the input value one bit to the left (from least significant to most
Carry significant bit), inserts carry in the low-order bit, and returns the most significant bit.
Function
Rotate
Right With Rotates each bit in value one bit to the right (from most significant to least significant),
Carry inserts carry in the high-order bit, and returns the least significant bit.
Function
Logical
Shift Shifts x the number of bits specified by y.
Function
Rotate
Rotates x the number of bits specified by y.
Function
Split
Number Breaks a number into its component bytes or words.
Function
Join
Numbers Creates a number from the component bytes or words.
Function
Swap Swaps the high-order 8 bits and the low-order 8 bits for every word in data.

550 ni.com
Functions

Palette
Description
Object
Bytes
Function
Swap
Words Swaps the high-order 16 bits and the low-order 16 bits for every long integer in data.
Function

Byte Array Computes the message digest on a byte array. You must manually select the
Checksum polymorphic instance you want to use.

Type Cast Function

Casts x to the data type, type, by flattening it and unflattening it using the new data
type. If the function must reinterpret data instead of transforming it, LabVIEW uses a
temporary buffer. This function has the risk of reinterpreting data. To preserve the data
value while converting the data, use the Coerce To Type function instead.

Note You can also use the Conversion VIs and functions to convert data
types.

Inputs/Outputs
• type —

type is the data type to which you want to convert the data. Wire any constant or control to type
to set the data type to which you want to convert the data. LabVIEW ignores any data in the
constant or control you wire to type.

• x—

x specifies the data you want to convert.

© National Instruments 551


Functions

This input accepts any data type.

• *(type *) &x —

*(type *) &x is the value provided in x and converted to the same data type as type.

Choosing between the Type Cast Function and the Coerce To Type
Function

The Coerce To Type function also converts data to a desired data type. Unlike the
Coerce To Type function, the Type Cast function allows conversion between
incompatible data types by flattening and unflattening the input data, which allows for
radical reinterpretation of the data. When the desired data type requires a different
memory size than the input data, the Type Cast function may reinterpret the input
data. The Coerce To Type function allows only conversion between compatible data
types to preserve the value of the input data, similar to what a coercion dot does. You
also can use the Coerce To Type function to convert a type definition or rename data
on the wire, such as a user event refnum. NI recommends that you use the Coerce To
Type function instead of the Type Cast function to avoid reinterpreting the data.

Effects of Mismatching the Sizes of X and Type

This function can generate unexpected data if x and type are not the same size. If x
requires more bits of storage than type, this function uses the upper bytes of x and
discards the remaining lower bytes. If x is of a smaller data type than type, this
function moves the data in x to the upper bytes of type and fills the remaining bytes
with zeros. For example, an 8-bit unsigned integer with value 1 type cast to a 16-bit
unsigned integer results in a value of 256.

Type Casting Arrays

You can use this function with an array of scalars or an array of clusters of scalars. For
example, if you typecast an array of four 16-bit integers to an array of 32-bit integers,
the output array contains two elements, each formed from the bits of pairs of elements
from the input array. If the input array does not contain enough bytes to form a whole
number of output elements, LabVIEW omits the final elements of the input array.

552 ni.com
Functions

Type Casting References

If you want to upcast or downcast references, use the To More Generic Class function
and the To More Specific Class function instead of the Type Cast function. The Type
Cast function does not provide error checking, but the To More Generic Class function
and the To More Specific Class function do. The To More Specific Class function has
error in and error out parameters. The To More Generic Class function breaks the wire
at edit time when you wire a reference to an incompatible target class.

Type Casting Boolean Data from Early Versions of LabVIEW

If x might contain Boolean data created with LabVIEW 4.x or earlier, right-click this
function and select Convert 4.x Data from the shortcut menu to convert the data to a
format that is readable by LabVIEW 5.0 and later. In Convert 4.x Data mode, this
function interprets x as if the data is stored in LabVIEW 4.x data storage layout and
displays the icon for this function with a red 4.x on it. LabVIEW 4.x and earlier stores
Boolean data in two bytes unless the data is in an array, in which case LabVIEW stores
each Boolean element in a single bit. LabVIEW 5.0 and later stores Boolean values in a
single byte, regardless of whether it is in an array. National Instruments recommends
reworking any application that uses the Convert 4.x Data mode as a long term
solution.

Flatten To String Function

Converts the anything input to a flattened data string of binary values. You also can
use this function to convert the byte order, or endian format, of the data in the
flattened data string.

Inputs/Outputs
• anything —

© National Instruments 553


Functions

anything contains the data you want to convert to a UTF-8 JSON string. This input accepts arrays
and clusters of Booleans, floating-point numbers, and strings. anything can also accept an array
of clusters, or a cluster of arrays, of these data types. This input does not support other data
types, such as enums, refnums, file paths, and fixed-point numbers.

Cluster elements may be named or unnamed, but not a combination of both. If cluster elements
are named, then each name must be unique to that cluster. If you wire an unsupported data
type, LabVIEW breaks the VI.

• prepend array or string size? (T) —

prepend array or string size? specifies whether LabVIEW includes data size information at the
beginning of data string when anything is an array or string. If prepend array or string size? is
FALSE, LabVIEW does not include the size information. The default is TRUE.

The string created by the Flatten To String function is a LabVIEW string. If prepend array or
string size? is TRUE, the LabVIEW string has a 4-byte (I32) number at the beginning of the string
that tells how long the string is. This enables a LabVIEW string to include NULL characters [ASCII
character zero (0)]. If you pass a LabVIEW string to external code and use it as a C string, NULL
characters embedded in the string may cause problems, since C strings are interpreted as
terminating at the first NULL character. prepend array or string size? only controls the top-level
data size information. Arrays and strings in hierarchical data types such as clusters always
include size information.

• byte order (0:big-endian, network order) —

byte order sets the endian format of the data in the resulting flattened string. Byte order, or
endian form, indicates whether integers are represented in memory from most significant byte
to least significant byte or vice versa.

big-endian, network order (default)—The most significant byte occupies the lowest memory
0
address.
1 native, host order—Uses the byte-ordering format of the host computer.
2 little-endian—The least significant byte occupies the lowest memory address.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• data string —

554 ni.com
Functions

data string is the flattened data generated by the function.

data string might contain header information before each non-scalar component describing its
size. Such a string can be stored in a file or sent over a network. If you send the string over a
network, the receiver must be able to interpret it. Usually, LabVIEW stores data as
noncontiguous, indirectly referenced pieces. This function copies the data in LabVIEW form into
a contiguous buffer data string. Use the Unflatten From String function to convert a data string
back to any data type.

• type string (7.x only) —

type string (7.x only) is visible only if the terminal is already wired from a previous version of
LabVIEW or if you right-click the function and select Convert 7.x Data from the shortcut menu.
type string (7.x only) is an encoded binary description of data string. type string (7.x only) is
not the same as the type input in the Unflatten From String function.

If type string (7.x only) cannot represent the data type wired to anything, this function returns
an error.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Type Cast function for conversion of data types that does not result in
flattened data.

If you need to flatten type descriptor data to a string that is readable by LabVIEW 7.x or
earlier, right-click this function and select Convert 7.x Data from the shortcut menu. In
Convert 7.x Data mode, this function shows the type string (7.x only) output and
displays the icon for this function with a red 7.x on it. LabVIEW 7.x and earlier stores
type descriptors in 16-bit flat representation. LabVIEW 8.0 and later stores type
descriptors in 32-bit flat representation. National Instruments recommends reworking
any application that uses the Convert 7.x Data mode as a long term solution.

If you need to flatten Boolean data to a string that is readable by LabVIEW 4.x or
earlier, right-click this function and select Convert 4.x Data from the shortcut menu.
The Convert 4.x Data shortcut menu item is visible only if you wire Boolean data to
anything. In Convert 4.x Data mode, this function writes the data in LabVIEW 4.x data
storage layout and displays the icon for this function with a red 4.x on it. LabVIEW 4.x

© National Instruments 555


Functions

and earlier stores Boolean data in two bytes unless the data is in an array, in which
case LabVIEW stores each Boolean element in a single bit. LabVIEW 5.0 and later stores
Boolean values in a single byte, regardless of whether it is in an array. National
Instruments recommends reworking any application that uses the Convert 4.x Data
mode as a long term solution.

If you use this function to flatten variant data, LabVIEW flattens the variant and all its
contents, including attributes. However, if you use the Variant To Flattened String
function, LabVIEW flattens only the variant and discards any attributes.

If you use this function to flatten data from a custom control or indicator that you
saved as a type definition, the function strips the type definition of its type definition
wrapper. If you do not want to strip this wrapper, right-click the function and select
Expose Typedefs from the shortcut menu. The Expose Typedefs shortcut menu item is
visible only if you wire data to type string (7.x only).

Unflatten From String Function

Converts binary string to the type wired to type. binary string should contain
flattened data of the type wired to type. You also can use this function to specify the
byte order, or endian format, of the data in the binary string.

Inputs/Outputs
• type —

type is a normally constructed LabVIEW type.

type is not the type string output in the Flatten To String function.

• binary string —

binary string is a flattened string that is typically generated by the Flatten To String function.

556 ni.com
Functions

If data includes array or string size? is TRUE, binary string contains header information
describing its size.

• data includes array or string size? (T) —

data includes array or string size? indicates whether LabVIEW reads data size information from
the beginning of an incoming array or string. If data includes array or string size? is TRUE,
LabVIEW reads the size information from the beginning of binary string. If data includes array or
string size? is FALSE, LabVIEW detects the size information from the memory size of binary
string.

The default is TRUE. data includes array or string size? only accesses the top-level data size
information. Arrays and strings in hierarchical data types such as clusters always include size
information.

• byte order (0:big-endian, network order) —

byte order indicates the endian format of the data in the incoming flattened string. Byte order,
or endian form, indicates whether integers are represented in memory from most-significant
byte to least-significant byte or vice versa.

big-endian, network order (default)—The most-significant byte occupies the lowest memory
0
address.
1 native, host order—Uses the byte-ordering format of the host computer.
2 little-endian—The least-significant byte occupies the lowest memory address.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• rest of the binary string —

rest of the binary string contains any leftover bytes that this function did not convert. This
function does not convert all the bytes if the size of binary string is not a multiple of the size of
type.

• value —

value returns binary string as unflattened data of the same data type and structure as type.

• error out —

© National Instruments 557


Functions

error out contains error information. This output provides standard error out functionality.

Use the Type Cast function for conversion of data types that does not require already-
flattened data.

If you need to unflatten data from a string created by LabVIEW 4.x or earlier, right-click
this function and select Convert 4.x Data from the shortcut menu. In Convert 4.x Data
mode, this function interprets the data in LabVIEW 4.x data storage layout and displays
the icon for this function with a red 4.x on it. LabVIEW 4.x and earlier stores Boolean
data in two bytes unless the data is in an array, in which case LabVIEW stores each
Boolean element in a single bit. LabVIEW 5.0 and later stores Boolean values in a single
byte, regardless of whether it is in an array. National Instruments recommends
reworking any application that uses the Convert 4.x Data mode as a long term
solution.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Binary\Endian Considerations\


Endian Considerations with Binary Files.vi
• labview\examples\Strings\Unflatten from String with
Little-Endian Data.vi

Mantissa & Exponent Function

Returns the mantissa and exponent of the input numeric value such that number =
mantissa * 2^exponent.

If number is 0, both mantissa and exponent are 0. Otherwise, the absolute value of
mantissa is greater than or equal to 1 and less than 2, and the value of exponent is an
integer. The connector pane displays the default data types for this polymorphic
function.

558 ni.com
Functions

Inputs/Outputs
• number —

number can be any decimal representation.

• mantissa —

mantissa has the same decimal representation as number.

• exponent —

exponent has the same decimal representation as number.

Rotate Left With Carry Function

Rotates each bit in the input value one bit to the left (from least significant to most
significant bit), inserts carry in the low-order bit, and returns the most significant bit.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• carry —

carry is the new low-order bit of value.

• value —

value must be an integer. It cannot be an array or a cluster.

• msb carry out —

msb carry out is the former high-order bit of value.

• value —

© National Instruments 559


Functions

value is the new value.

The data type of the output value is determined by the data type of the input value.

Rotate Right With Carry Function

Rotates each bit in value one bit to the right (from most significant to least significant),
inserts carry in the high-order bit, and returns the least significant bit.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• carry —

carry is the new high-order bit of value.

• value —

value must be an integer. It cannot be an array or a cluster.

• lsb carry out —

lsb carry out is the former low-order bit of value.

• value —

value is the new value.

The data type of the output value is determined by the data type of the input value.

Logical Shift Function

Shifts x the number of bits specified by y.

The connector pane displays the default data types for this polymorphic function.

560 ni.com
Functions

Inputs/Outputs
• y—

y can be any numeric representation. If y is greater than 0, the function shifts x left y bits (from
least significant to most significant bit) and inserts zeros in the low-order bits. If y is less than 0,
the function shifts x right y bits in the positive direction (from most significant to least significant
bit) and inserts zeros in the high-order bits.

• x—

x can be any integer representation. If x is an 8-, 16-, 32-, or 64-bit integer and y is greater than 8,
16, or 32, or 64 or is less than –8, –16, –32, or –64, respectively, the output value is all zeros.

• x << y —

x << y is the result of the shift and has the same numeric representation as x.

Rotate Function

Rotates x the number of bits specified by y.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• y—

y specifies the number of bits in x that the function rotates.

If y is greater than 0, the function shifts the first y bits at the left end of x to the right end. If y is
less than 0, the function shifts the first y bits at the right end of x to the left end.
• x—

© National Instruments 561


Functions

If x is an 8-, 16-, 32-, or 64-bit integer, then for any value of y, y ± 8, y ± 16, y ± 32, or y ± 64 yields
the same output value, respectively, as y.

For example, if x is an 8-bit integer, y = 1 and y = 9 yield the same result.


• x rotated left by y —

x rotated left by y is the result of the rotation.

The data type of x rotated left by y is determined by the data type of the x input.

The following table illustrates how x and y affect x rotated left by y:

x rotated left by
y x Comments
y
3 This function shifts the first one bit on the left, 0, to the right
1 6 (00000110)
(00000011) end.
3 This function shifts the first two bits on the left, 00, to the right
2 12 (00001100)
(00000011) end.
3 This function shifts the first three bits on the right, 011, to the
–3 96 (01100000)
(00000011) left end.

Split Number Function

Breaks a number into its component bytes or words.

Inputs/Outputs
• x—

x can be an 8-, 16-, 32-, or 64-bit integer, or an array or cluster of those representations.

• hi(x) —

hi(x) and lo(x) are integers that are half the width of x. hi(x) and lo(x) are 8-bit, 16-bit, or 32-bit

562 ni.com
Functions

unsigned integers, respectively, or an array or cluster of those representations. hi(x) is the


numerically high-order byte and lo(x) is the numerically low-order byte, regardless of the
endianness of the operating system.

• lo(x) —

If you wire an 8-bit integer input, this function does not split the number. Instead,
LabVIEW returns the same 8-bit number in the lo(x) output, and returns zero for the
hi(x) output.

Join Numbers Function

Creates a number from the component bytes or words.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• hi —

hi can be an 8-, 16-, or 32-bit number or an array or cluster of that representation.

• lo —

lo can be an 8-, 16-, or 32-bit number or an array or cluster of that representation.

• (hi.lo) —

(hi.lo) is an integer twice the width of hi and lo. (hi.lo) is a 16-, 32-, or 64-bit unsigned integer or
an array or cluster of those representations. If hi and lo are of different widths, (hi.lo) is twice the
width of the widest number.

Swap Bytes Function

Swaps the high-order 8 bits and the low-order 8 bits for every word in data.

© National Instruments 563


Functions

If you want to byte-swap floating-point or fixed-point numbers, use the Type Cast
function to cast the value to a 1D array of bytes by wiring an array of numeric controls
to the type input and the floating-point or fixed-point numbers to the x input. Then
use the Reverse 1D Array function to convert the array to a floating-point number with
the elements reversed. The connector pane displays the default data types for this
polymorphic function.

Inputs/Outputs
• data —

data is an integer, an array of integers, or a cluster containing integers that you want to byte
swap. If data is a cluster that contains integers, this function swaps only the integer elements of
the cluster. Neither refnums or variants are valid inputs. Both will break the input wire.

• byte swapped —

byte swapped is of the same data type and structure as data.

Swap Words Function

Swaps the high-order 16 bits and the low-order 16 bits for every long integer in data.

For example, if the input in hexadecimal format is 1234567890ABCDEF, this


function swaps 1234 with 5678 and 90AB with CDEF, returning
56781234CDEF90AB. The connector pane displays the default data types for this
polymorphic function.

Inputs/Outputs
• data —

564 ni.com
Functions

data is an integer, an array of integers, or a cluster containing integers that you want to word
swap. In the case of a cluster that contains integers, this function swaps only the integer
elements of the cluster.

If you want to byte-swap floating-point or fixed-point numbers, use the Type Cast function to
cast the value to a 1D array of bytes. Then use the Reverse 1D Array function and type cast it back
to a floating-point or fixed-point number. Neither refnums or variants are valid inputs. Both will
break the input wire.
• word swapped —

word swapped is of the same data type and structure as data.

Byte Array Checksum

Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

• SHA-256 Byte Array Checksum VI


• SHA-224 Byte Array Checksum VI
• SHA-384 Byte Array Checksum VI
• SHA-512 Byte Array Checksum VI
• SHA-512-256 Byte Array Checksum VI
• SHA-512-224 Byte Array Checksum VI
• SHA3-224 Byte Array Checksum VI
• SHA3-256 Byte Array Checksum VI
• SHA3-384 Byte Array Checksum VI
• SHA3-512 Byte Array Checksum VI

SHA-256 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

© National Instruments 565


Functions

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA-256 message digest of the byte array, or buffer, as a hexadecimal string.

SHA-224 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA-224 message digest of the byte array, or buffer, as a hexadecimal string.

SHA-384 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

566 ni.com
Functions

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA-384 message digest of the byte array, or buffer, as a hexadecimal string.

SHA-512 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA-512 message digest of the byte array, or buffer, as a hexadecimal string.

SHA-512-256 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

© National Instruments 567


Functions

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA-512/256 message digest of the byte array, or buffer, as a hexadecimal
string.

SHA-512-224 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA-512/224 message digest of the byte array, or buffer, as a hexadecimal
string.

SHA3-224 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the

568 ni.com
Functions

polymorphic instance you want to use.

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA3-224 message digest of the byte array, or buffer, as a hexadecimal string.

SHA3-256 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA3-256 message digest of the byte array, or buffer, as a hexadecimal string.

SHA3-384 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the

© National Instruments 569


Functions

polymorphic instance you want to use.

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA3-384 message digest of the byte array, or buffer, as a hexadecimal string.

SHA3-512 Byte Array Checksum VI


Computes the message digest on a byte array. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• buffer —

buffer specifies the byte array, or buffer, for which you want to compute the message digest.

• digest —

digest returns the SHA3-512 message digest of the byte array, or buffer, as a hexadecimal string.

Absolute Value Function

Returns the absolute value of the input.

570 ni.com
Functions

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, a fixed-point number, an array or cluster of numbers, an array of


clusters of numbers, and so on.

x cannot be an unsigned integer, because unsigned integers represent only non-negative


integers.

• abs(x) —

abs(x) is the absolute value of x.

When x is of the form x = a + bi, that is, when x is complex, the following equation defines abs(x):

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the inputs. Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns a NaN.

If the absolute value of x is outside the range of the data type of x, abs(x) overflows to
a value within the range of the data type. For example, if x is an 8-bit integer and the
value of x is -128, abs(x) returns -128 since 128 is outside the range of 8-bit integers,
-128 to 127.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

© National Instruments 571


Functions

Round To Nearest Function

Rounds the input to the nearest integer. If the value of the input is midway between
two integers, the function returns the nearest even integer.

For example, if number is 1.5 or 2.5, nearest integer value is 2.

Note Note IEEE standards determine the rounding method for this function.
This method produces more accurate values with no positive or negative bias
because it does not round all integers in the same direction.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• nearest integer value —

nearest integer value is the resulting nearest integer to number. If the input is a time stamp
value, the function rounds to the nearest second.

When number is in the form of a + bi, that is, when number is complex, the function returns a
complex number defined by the nearest integer to the real and imaginary parts of number. The
following equation defines nearest integer value: nearest integer value(x) = nearest integer
value(a) + i * nearest integer value(b)

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

572 ni.com
Functions

Round Toward -Infinity Function

Truncates the input to the next lowest integer.

For example, if the input is 3.8, the result is 3. If the input is –3.8, the result is –4. The
connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• floor(x): largest int <= x —

floor(x): largest int ≤ x is the resulting lowest integer, closest to x. If the input is a time stamp
value, the function rounds to the previous second.

When x is of the form x = a + bi, that is, when x is complex, the function returns a complex
number defined by the next lowest integers to the real and imaginary parts of x. The following
equation defines floor(x): largest int ≤ x: floor(x) = floor(a) + i floor(b)

Round Toward +Infinity Function

Rounds the input to the next highest integer.

For example, if the input is 3.1, the result is 4. If the input is –3.1, the result is –3. The
connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

© National Instruments 573


Functions

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• ceil(x): smallest int >= x —

ceil(x): smallest int >= x is the resulting highest integer, closest to x. If the input is a time stamp
value, the function rounds to the next second.

When x is of the form x = a + bi, that is, when x is complex, the function returns a complex
number defined by the next highest integers to the real and imaginary parts of x. The following
equation defines ceil(x): smallest int >= x: ceil(x) = ceil(a) + i ceil(b)

Scale By Power Of 2 Function

Multiplies x by 2 raised to the power of n.

If x is an integer or fixed-point number, this function is the equivalent of an arithmetic


shift. The connector pane displays the default data types for this polymorphic
function.

Inputs/Outputs
• n—

n can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

If n is a floating-point number, this function rounds n before it scales x (0.5 rounds to 0; 0.51
rounds to 1). If n is a 64-bit integer, LabVIEW coerces n to a 32-bit integer.
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• x*2^n —

x*2^n is the result of multiplying x by 2, raised to the power of n.

If you wire a fixed-point value to this function, the resulting output value retains the

574 ni.com
Functions

fixed-point configuration settings of the input value. However, the value is likely to
truncate or wrap.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Complex

Use the Complex functions to create complex numbers from two values given in
rectangular or polar and to break a complex number into its rectangular or polar
components.

Palette Object Description


Complex Conjugate
Produces the complex conjugate of x + iy.
Function
Polar To Complex
Creates a complex number from two values in polar notation.
Function
Complex To Polar
Breaks a complex number into its polar components.
Function
Re/Im To Complex
Creates a complex number from two values in rectangular notation.
Function
Complex To Re/Im
Breaks a complex number into its rectangular components.
Function
Converts the rectangular components of a complex number into its polar
Re/Im To Polar Function
components.
Converts the polar components of a complex number into its rectangular
Polar To Re/Im Function
components.

© National Instruments 575


Functions

Complex Conjugate Function

Produces the complex conjugate of x + iy.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x + iy —

x + iy can be a complex number, array or cluster of complex numbers, an array of cluster of


complex numbers, and so on.

• x - iy —

x - iy is the complex conjugate of x + iy.

Polar To Complex Function

Creates a complex number from two values in polar notation.

The dimensions of two matrices that you want to combine must be the same.
Otherwise, this function returns an empty complex matrix. The connector pane
displays the default data types for this polymorphic function.

Inputs/Outputs
• r—

r can be a scalar number, an array or cluster of numbers, array of clusters of numbers, and so on.

• theta —

576 ni.com
Functions

theta can be a scalar number, an array or cluster of numbers, array of clusters of numbers, and
so on. theta is in radians.

• r * e^(i*theta) —

r * e^(i*theta) is of the same data type structure as r and theta, with complex representation
instead of scalar.

Given z in rectangular form z = a + bi, this function converts the polar components
according to the following equation:

z = r*cos(theta) + i r*sin(theta)

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

Complex To Polar Function

Breaks a complex number into its polar components.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• r * e^(i*theta) —

r * e^(i*theta) can be a complex number, a cluster of complex numbers, an array of complex


numbers, an array of clusters of complex numbers, and so on.

• r—

© National Instruments 577


Functions

r is of the same data type structure as r * e^(i*theta), with scalar representation instead of
complex.

• theta —

theta is of the same data type structure as r * e^(i*theta), with scalar representation instead of
complex. theta is in radians.

Given z in rectangular form z = a + bi, this function converts the polar components of z
= r * e^(i*theta) according to the following equations:

r = |z| = sqrt(a² + b²) theta = arg(z) = arctan2(b,a)

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

Re/Im To Complex Function

Creates a complex number from two values in rectangular notation.

The dimensions of two matrices that you want to combine must be the same.
Otherwise, this function returns an empty complex matrix. The connector pane
displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• y—

578 ni.com
Functions

y can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• x + iy —

x + iy has the same structure as the input, with complex representation instead of scalar.

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

Complex To Re/Im Function

Breaks a complex number into its rectangular components.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x + iy —

x + iy can be a complex number, array or cluster of complex numbers, an array of cluster of


complex numbers, and so on.

• x—

x is of the same data type structure as x + iy, with scalar representation instead of complex.

• y—

y is of the same data type structure as x + iy, with scalar representation instead of complex.

When you wire matrix data as an input to this function, a VI that includes subVIs that

© National Instruments 579


Functions

work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

Re/Im To Polar Function

Converts the rectangular components of a complex number into its polar components.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• y—

y can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• r—

r is of the same data type structure as x and y.

• theta —

theta is of the same data type structure as x and y. theta is in radians.

This function converts the rectangular components to polar components using the
following equations:

r = sqrt(x² + y²) theta = arctan2(y,x) radians

580 ni.com
Functions

Polar To Re/Im Function

Converts the polar components of a complex number into its rectangular components.

Inputs/Outputs
• r—

r can be a scalar number, an array or cluster of numbers, array of clusters of numbers, and so on.

• theta —

theta can be a scalar number, an array or cluster of numbers, array of clusters of numbers, and
so on. theta is in radians.

• x—

x is of the same data structure as r and theta.

• y—

y is of the same data structure as r and theta.

This function converts the polar components to rectangular components using


following equations:

x = r*cos(theta) y = r*sin(theta)

Square Root Function

Computes the square root of the input value.

If x is negative, the square root is NaN unless x is complex. If x is a matrix, this function
takes the matrix square root of x. The connector pane displays the default data types
for this polymorphic function.

© National Instruments 581


Functions

Note If you wire a value that has a unit with an odd exponent to the square
root function, the wire breaks because LabVIEW does not support units with
fractional exponents. For example, 15m² is an acceptable input value, but
15m3 is not an acceptable input value.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• sqrt(x) —

sqrt(x) is a double-precision, floating-point number if x is an integer.

If x is less than 0, sqrt(x) is not a number (NaN), unless x is complex. When x is of the form x = a +
bi, that is, when x is complex, the function defines the magnitude and phase with the following
equations: where |x| is the magnitude of x and arg(x) is the

phase of x: arg(x) = arctan2(b,a)

Note You can manually configure this function to output data of a type you want. To
specify the output data type, right-click the function and select Properties to display
the Object Properties dialog box. On the Output Configuration page, click the
Representation icon and select the data type you want. A blue coercion dot appears
on the output terminal of the function to indicate that you have configured the
output data type.

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

582 ni.com
Functions

Refer to the Matrix Square Root VI for more information.

Fixed-Point Details

If you wire a signed fixed-point value to this function, the function converts the signed
number into a floating-point number and performs the square root operation. By
default, LabVIEW configures the integer word length of the square root to avoid
overflow. However, because the precision of the square root can be infinite, rounding
conditions always occur. Use the Numeric Node Properties dialog box to configure
how LabVIEW handles overflow and rounding of fixed-point data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Square Function

Computes the square of the input value.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• x^2 —

x^2 is of the same numeric representation as x.

Note You can manually configure this function to output data of a type you want. To
specify the output data type, right-click the function and select Properties to display

© National Instruments 583


Functions

the Object Properties dialog box. On the Output Configuration page, click the
Representation icon and select the data type you want. A blue coercion dot appears
on the output terminal of the function to indicate that you have configured the
output data type.

If you wire fixed-point values to Numeric functions such as Add, Subtract, Multiply, and
Square, the functions usually return values that do not lose any bits of word length.
However, if the operation creates a value that exceeds the maximum word length that
LabVIEW accepts, overflow or rounding conditions can occur. LabVIEW accepts a
maximum word length of 64 bits. Use the Numeric Node Properties dialog box to
configure how LabVIEW handles overflow or rounding of fixed-point data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Negate Function

Negates the input value.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, a fixed-point number, an array or cluster of numbers, an array of


clusters of numbers, and so on. x cannot be an unsigned integer, because unsigned integers
represent only non-negative integers.

• -x —

584 ni.com
Functions

-x is the negative value of x.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Reciprocal Function

Divides 1 by the input value.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar number, array or cluster of numbers, array of clusters of numbers, and so on.

• 1/x —

1/x is infinity if x is 0. If x is an integer, 1/x is a double-precision, floating-point number.

Fixed-Point Details

If you wire a fixed-point value to this function, by default LabVIEW configures the
integer word length of the reciprocal to avoid overflow. However, because the
precision of the reciprocal can be infinite, rounding conditions always occur. Use the
Numeric Node Properties dialog box to configure how LabVIEW handles rounding of
fixed-point data. This function always uses the Saturate overflow mode to handle
overflow.

© National Instruments 585


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Numeric Functions.vi

Sign Function

Returns the sign of number.

Note For nonzero complex numbers, this function returns a complex value
with the same phase as the input and with a magnitude of 1.

Text-based programming languages typically call this function signum or sgn. The
connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• -1, 0, 1 —

–1, 0, 1 returns 1 if the input value is greater than 0, returns 0 if the input value is equal to 0, and
returns –1 if the input value is less than 0.

When number is in the form of a + bi, that is, when number is complex, the following defines -1,
0, 1:

Examples

Refer to the following example files included with LabVIEW.

586 ni.com
Functions

• labview\examples\Numerics\Numeric Functions.vi

Scaling

Use the Scaling VIs to convert voltage readings to other temperature or strain units.

Palette Object Description

Converts a voltage you read from an RTD into temperature in Celsius. Wire data to
Convert RTD
the RTDvolts input to determine the polymorphic instance to use or manually
Reading
select the instance.

Convert Strain Converts a voltage read from a strain gauge to units of strain. Wire data to the Vsg
Gauge input to determine the polymorphic instance to use or manually select the
Reading instance.

Converts a thermistor voltage into a temperature. This VI has different modes of


Convert
operation for voltage-excited and current-excited thermistors. Wire data to the
Thermistor
Voltage input to determine the polymorphic instance to use or manually select the
Reading
instance.

Converts a voltage reading from a thermocouple into a temperature value. Wire


Convert
data to the Voltage Waveform (waveform), Voltage Array (array), or Thermocouple
Thermocouple
Voltage (scalar) input to determine the polymorphic instance to use or manually
Reading
select the instance.

Radians to
Converts data from radians to degrees.
Degrees

Degrees to
Converts data from degrees to radians.
Radians

© National Instruments 587


Functions

Palette Object Description


RPM to
Radians per Converts data from revolutions per minute (RPM) to radians per second.
Second
Radians per
Second to Converts data from radians per second to revolutions per minute (RPM).
RPM

Convert RTD Reading

Converts a voltage you read from an RTD into temperature in Celsius. Wire data to the
RTDvolts input to determine the polymorphic instance to use or manually select the
instance.

• Convert RTD Reading (waveform) VI


• Convert RTD Reading (scaler) VI

Convert RTD Reading (waveform) VI


Converts a voltage you read from an RTD into temperature in Celsius. Wire data to the
RTDvolts input to determine the polymorphic instance to use or manually select the
instance.

Inputs/Outputs
• Ro —

588 ni.com
Functions

Ro is the RTD resistance at 0° C. The default is 100 Ω.

• RTDvolts —

RTDvolts is the voltage you read from the RTD.

• Iex —

Iex is the excitation current you used with the RTD. This parameter defaults to an excitation
current of 0.15 mA.

• A—

A is a coefficient of the Callendar Van-Dusen equation that fits your RTD. The default coefficients
are those for the European curve (also called the DIN 43760 standard).

• B—

B is a coefficient of the Callendar Van-Dusen equation that fits your RTD. The default coefficients
of this equation are those for the European curve (also called the DIN 43760 standard).

• RTDtemp —

RTDtemp is the return temperature value in degrees Celsius.

Convert RTD Reading (scaler) VI


Converts a voltage you read from an RTD into temperature in Celsius. Wire data to the
RTDvolts input to determine the polymorphic instance to use or manually select the
instance.

Inputs/Outputs
• Ro —

© National Instruments 589


Functions

Ro is the RTD resistance at 0° C. The default is 100 Ω.

• RTDvolts —

RTDvolts is the voltage you read from the RTD.

• Iex —

Iex is the excitation current you used with the RTD. This parameter defaults to an excitation
current of 0.15 mA.

• A—

A is a coefficient of the Callendar Van-Dusen equation that fits your RTD. The default coefficients
are those for the European curve (also called the DIN 43760 standard).

• B—

B is a coefficient of the Callendar Van-Dusen equation that fits your RTD. The default coefficients
of this equation are those for the European curve (also called the DIN 43760 standard).

• RTDtemp —

RTDtemp is the return temperature value in degrees Celsius.

Convert Strain Gauge Reading

Converts a voltage read from a strain gauge to units of strain. Wire data to the Vsg
input to determine the polymorphic instance to use or manually select the instance.

• Convert Strain Gauge Reading (waveform) VI


• Convert Strain Gauge Reading (scaler) VI

The conversion formula the VI uses is based solely on the bridge configuration. The
following illustrations show the seven bridge configurations you can use and the
corresponding formulas. For all bridge configurations, the VI uses the following
formula to obtain Vr.

590 ni.com
Functions

Vr= (Vsg – Vinit) / Vex

In the circuit diagrams, VOUT is the voltage you measure and pass to the conversion VI
as the Vsg. In the quarter-bridge and half-bridge configurations, R1 and R2 are dummy
resistors that are not directly incorporated into the conversion formula.

The following illustrations show the available bridge-completion networks.

© National Instruments 591


Functions

592 ni.com
Functions

Convert Strain Gauge Reading (waveform) VI


Converts a voltage read from a strain gauge to units of strain. Wire data to the Vsg
input to determine the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• Rg (120) —

Rg is the strain gauge nominal resistance value in ohms. The default is 120 Ω.

• GF (2.0) —

GF is the gauge factor of the strain gauge.

• v (0.0) —

v is Poisson's Ratio. This parameter is only required for certain bridge configurations.

• Vsg (0.0) —

Vsg is the voltage you read from the strain gauge.

• Bridge Configuration (3:Half Bridge II) —

Bridge Configuration indicates the type of bridge configuration in which the strain gauge is
mounted. The default is Half Bridge II.

This input accepts the following values.

0 Qtr Bridge I
1 Qtr Bridge II

© National Instruments 593


Functions

2 Half Bridge I
3 Half Bridge II (default)
4 Full Bridge I
5 Full Bridge II
6 Full Bridge III

• Vex (3.33) —

Vex is the excitation voltage you use. The defaults is 3.333 V.

• Vinit (0.0) —

Vinit is the unstrained voltage of the strain gauge after you mount it in its bridge configuration.
Read this voltage at the beginning of your application and save it to pass to this VI.

• Rl (0.0) —

Rl is the lead resistance. The Rl parameter defaults to 0. In many cases, the lead resistance is
negligible and you can leave this terminal unwired.

• Strain —

Strain is the return strain value.

The conversion formula the VI uses is based solely on the bridge configuration. The
following illustrations show the seven bridge configurations you can use and the
corresponding formulas. For all bridge configurations, the VI uses the following
formula to obtain Vr.

Vr= (Vsg – Vinit) / Vex

In the circuit diagrams, VOUT is the voltage you measure and pass to the conversion VI
as the Vsg. In the quarter-bridge and half-bridge configurations, R1 and R2 are dummy
resistors that are not directly incorporated into the conversion formula.

The following illustrations show the available bridge-completion networks.

594 ni.com
Functions

© National Instruments 595


Functions

596 ni.com
Functions

Convert Strain Gauge Reading (scaler) VI


Converts a voltage read from a strain gauge to units of strain. Wire data to the Vsg
input to determine the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• Rg (120) —

Rg is the strain gauge nominal resistance value in ohms. The default is 120 Ω.

• GF (2.0) —

GF is the gauge factor of the strain gauge.

• v (0.0) —

v is Poisson's Ratio. This parameter is only required for certain bridge configurations.

• Vsg (0.0) —

Vsg is the voltage you read from the strain gauge.

• Bridge Configuration (3:Half Bridge II) —

Bridge Configuration indicates the type of bridge configuration in which the strain gauge is
mounted. The default is Half Bridge II.

This input accepts the following values.

0 Qtr Bridge I
1 Qtr Bridge II

© National Instruments 597


Functions

2 Half Bridge I
3 Half Bridge II (default)
4 Full Bridge I
5 Full Bridge II
6 Full Bridge III

• Vex (3.33) —

Vex is the excitation voltage you use. The defaults is 3.333 V.

• Vinit (0.0) —

Vinit is the unstrained voltage of the strain gauge after you mount it in its bridge configuration.
Read this voltage at the beginning of your application and save it to pass to this VI.

• Rl (0.0) —

Rl is the lead resistance. The Rl parameter defaults to 0. In many cases, the lead resistance is
negligible and you can leave this terminal unwired.

• Strain —

Strain is the return strain value.

The conversion formula the VI uses is based solely on the bridge configuration. The
following illustrations show the seven bridge configurations you can use and the
corresponding formulas. For all bridge configurations, the VI uses the following
formula to obtain Vr.

Vr= (Vsg – Vinit) / Vex

In the circuit diagrams, VOUT is the voltage you measure and pass to the conversion VI
as the Vsg. In the quarter-bridge and half-bridge configurations, R1 and R2 are dummy
resistors that are not directly incorporated into the conversion formula.

The following illustrations show the available bridge-completion networks.

598 ni.com
Functions

© National Instruments 599


Functions

600 ni.com
Functions

Convert Thermistor Reading

Converts a thermistor voltage into a temperature. This VI has different modes of


operation for voltage-excited and current-excited thermistors. Wire data to the Voltage
input to determine the polymorphic instance to use or manually select the instance.

• Convert Thermistor Reading (waveform) VI


• Convert Thermistor Reading (scaler) VI

The Convert Thermistor Reading VI has two modes of operation for use with different
types of thermistor circuits. The following illustration shows how the thermistor can be
connected to a voltage reference.

The following illustration shows a circuit where the thermistor is excited by a constant
current source.

If the thermistor is excited by voltage, the following equation shows the relationship of
the thermistor resistance, RT, to the input values.

© National Instruments 601


Functions

If the thermistor is excited by current, the following equation shows the relationship of
the thermistor resistance, RT, to the input values.

The following equation shows the standard formula the VI uses for converting a
thermistor resistance to temperature.

The values used by this VI for A, B, and C are given below. If you are using a thermistor
with different values for A, B, and C (refer to the thermistor data sheet), you can edit
the VI diagram to use different A, B, and C values.

A = 1.295361E-3

B = 2.343159E-4

C = 1.018703E-7

The VI produces a temperature in degrees Celsius. Therefore, TC = TK – 273.15.

Convert Thermistor Reading (waveform) VI


Converts a thermistor voltage into a temperature. This VI has different modes of
operation for voltage-excited and current-excited thermistors. Wire data to the Voltage
input to determine the polymorphic instance to use or manually select the instance.

602 ni.com
Functions

Inputs/Outputs
• Type of Excitation —

Type of Excitation distinguishes the two modes of operation of the VI. This VI defaults to the
Voltage Reference mode. Use the Voltage Reference (VREF) and the R1 values only in this
mode. You use the Current Excitation (IEX) value only in the Current Reference mode.

This input accepts the following values.

0 Voltage Reference
1 Current Reference

• Voltage —

Voltage is the voltage read from a thermistor.

• Voltage Reference —

Voltage Reference (VREF) is the reference you apply across a resistor of known value in series
with your thermistor. The default is 2.5 V. Use this input only when you set Type of Excitation to
Voltage Reference.

• R1 —

R1 is the value of the resistor in series with your thermistor expressed in Ohms. The default is 5
kΩ. Use this input only when you set Type of Excitation to Voltage Reference.

• Excitation Current —

Excitation Current (IEX) is the current excitation applied to the thermistor. The default is 100 µA.
Use this input only when you set Type of Excitation to Current Reference.

• Temperature Units (C) —

Temperature Units is the units of temperature the VI outputs.

This input accepts the following values.

0 Celsius
1 Fahrenheit
2 Kelvin

© National Instruments 603


Functions

3 Rankine

• Temperature —

Temperature is the return temperature value in the units specified in Temperature Units.

The Convert Thermistor Reading VI has two modes of operation for use with different
types of thermistor circuits. The following illustration shows how the thermistor can be
connected to a voltage reference.

The following illustration shows a circuit where the thermistor is excited by a constant
current source.

If the thermistor is excited by voltage, the following equation shows the relationship of
the thermistor resistance, RT, to the input values.

If the thermistor is excited by current, the following equation shows the relationship of
the thermistor resistance, RT, to the input values.

604 ni.com
Functions

The following equation shows the standard formula the VI uses for converting a
thermistor resistance to temperature.

The values used by this VI for A, B, and C are given below. If you are using a thermistor
with different values for A, B, and C (refer to the thermistor data sheet), you can edit
the VI diagram to use different A, B, and C values.

A = 1.295361E-3

B = 2.343159E-4

C = 1.018703E-7

The VI produces a temperature in degrees Celsius. Therefore, TC = TK – 273.15.

Convert Thermistor Reading (scaler) VI


Converts a thermistor voltage into a temperature. This VI has different modes of
operation for voltage-excited and current-excited thermistors. Wire data to the Voltage
input to determine the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• Type of Excitation —

Type of Excitation distinguishes the two modes of operation of the VI. This VI defaults to the
Voltage Reference mode. Use the Voltage Reference (VREF) and the R1 values only in this
mode. You use the Current Excitation (IEX) value only in the Current Reference mode.

© National Instruments 605


Functions

This input accepts the following values.

0 Voltage Reference
1 Current Reference

• Voltage —

Voltage is the voltage read from a thermistor.

• Voltage Reference —

Voltage Reference (VREF) is the reference you apply across a resistor of known value in series
with your thermistor. The default is 2.5 V. Use this input only when you set Type of Excitation to
Voltage Reference.

• R1 —

R1 is the value of the resistor in series with your thermistor expressed in Ohms. The default is 5
kΩ. Use this input only when you set Type of Excitation to Voltage Reference.

• Excitation Current —

Excitation Current (IEX) is the current excitation applied to the thermistor. The default is 100 µA.
Use this input only when you set Type of Excitation to Current Reference.

• Temperature Units (C) —

Temperature Units is the units of temperature the VI outputs.

This input accepts the following values.

0 Celsius
1 Fahrenheit
2 Kelvin
3 Rankine

• Temperature —

Temperature is the return temperature value in the units specified in Temperature Units.

The Convert Thermistor Reading VI has two modes of operation for use with different

606 ni.com
Functions

types of thermistor circuits. The following illustration shows how the thermistor can be
connected to a voltage reference.

The following illustration shows a circuit where the thermistor is excited by a constant
current source.

If the thermistor is excited by voltage, the following equation shows the relationship of
the thermistor resistance, RT, to the input values.

If the thermistor is excited by current, the following equation shows the relationship of
the thermistor resistance, RT, to the input values.

The following equation shows the standard formula the VI uses for converting a
thermistor resistance to temperature.

The values used by this VI for A, B, and C are given below. If you are using a thermistor
with different values for A, B, and C (refer to the thermistor data sheet), you can edit

© National Instruments 607


Functions

the VI diagram to use different A, B, and C values.

A = 1.295361E-3

B = 2.343159E-4

C = 1.018703E-7

The VI produces a temperature in degrees Celsius. Therefore, TC = TK – 273.15.

Convert Thermocouple Reading

Converts a voltage reading from a thermocouple into a temperature value. Wire data to
the Voltage Waveform (waveform), Voltage Array (array), or Thermocouple Voltage
(scalar) input to determine the polymorphic instance to use or manually select the
instance.

Note This VI does not work with the NI 9211 C Series module. Instead, use
the NI 9211 Convert to Temperature VI located in the labview\examples\
CompactRIO\Module Specific\NI 9211\NI 9211 Support
Files.llb directory.

• Convert Thermocouple Reading (waveform) VI


• Convert Thermocouple Reading (array) VI
• Convert Thermocouple Reading (scaler) VI

Convert Thermocouple Reading (waveform)


VI
Converts a voltage reading from a thermocouple into a temperature value. Wire data to
the Voltage Waveform (waveform), Voltage Array (array), or Thermocouple Voltage
(scalar) input to determine the polymorphic instance to use or manually select the

608 ni.com
Functions

instance.

Note This VI does not work with the NI 9211 C Series module. Instead, use
the NI 9211 Convert to Temperature VI located in the labview\examples\
CompactRIO\Module Specific\NI 9211\NI 9211 Support
Files.llb directory.

Inputs/Outputs
• Temperature Units (C) —

Temperature Units is the units of temperature the VI outputs.

This input accepts the following values.

0 Celsius
1 Fahrenheit
2 Kelvin
3 Rankine

• Voltage Waveform —

Voltage Waveform is a waveform of voltages read from a thermocouple.

• ThermocoupleType —

ThermocoupleType can be B, E, J, K, R, S, T, or N.

This input accepts the following values. Refer to your thermocouple user manual for more
information about thermocouple types.

0 B
1 E

© National Instruments 609


Functions

2 J
3 K
4 R
5 S
6 T
7 N

• CJC Voltage —

CJC Voltage is the cold-junction compensation reference voltage. The CJC Voltage parameter is
either the IC sensor or the thermistor sensor, as specified by CJC Sensor.

• CJC Sensor(0) —

CJC Sensor is the type of cold-junction compensation sensor you are using.

A CJC Sensor value of 0 selects the IC sensor. A CJC Sensor value of 1 selects the thermistor
sensor.

• Type of Excitation —

Type of Excitation indicates the voltage and current reference.

This input accepts the following values.

0 Voltage Reference
1 Current Reference

• Temperature Waveform —

Temperature Waveform returns the linearized temperature value in the units specified in
Temperature Units.

Convert Thermocouple Reading (array) VI


Converts a voltage reading from a thermocouple into a temperature value. Wire data to
the Voltage Waveform (waveform), Voltage Array (array), or Thermocouple Voltage
(scalar) input to determine the polymorphic instance to use or manually select the
instance.

610 ni.com
Functions

Note This VI does not work with the NI 9211 C Series module. Instead, use
the NI 9211 Convert to Temperature VI located in the labview\examples\
CompactRIO\Module Specific\NI 9211\NI 9211 Support
Files.llb directory.

Inputs/Outputs
• Temperature Units (C) —

Temperature Units is the units of temperature the VI outputs.

This input accepts the following values.

0 Celsius
1 Fahrenheit
2 Kelvin
3 Rankine

• Voltage Array —

Voltage Array is an array of voltages read from a thermocouple.

• ThermocoupleType —

ThermocoupleType can be B, E, J, K, R, S, T, or N.

This input accepts the following values. Refer to your thermocouple user manual for more
information about thermocouple types.

0 B
1 E
2 J
3 K

© National Instruments 611


Functions

4 R
5 S
6 T
7 N

• CJC Voltage —

CJC Voltage is the cold-junction compensation reference voltage. The CJC Voltage parameter is
either the IC sensor or the thermistor sensor, as specified by CJC Sensor.

• CJC Sensor(0) —

CJC Sensor is the type of cold-junction compensation sensor you are using.

A CJC Sensor value of 0 selects the IC sensor. A CJC Sensor value of 1 selects the thermistor
sensor.

• Type of Excitation —

Type of Excitation indicates the voltage and current reference.

This input accepts the following values.

0 Voltage Reference
1 Current Reference

• Temperature Array —

Temperature Array returns the linearized temperature value in the units specified in
Temperature Units.

Convert Thermocouple Reading (scaler) VI


Converts a voltage reading from a thermocouple into a temperature value. Wire data to
the Voltage Waveform (waveform), Voltage Array (array), or Thermocouple Voltage
(scalar) input to determine the polymorphic instance to use or manually select the
instance.

612 ni.com
Functions

Note This VI does not work with the NI 9211 C Series module. Instead, use
the NI 9211 Convert to Temperature VI located in the labview\examples\
CompactRIO\Module Specific\NI 9211\NI 9211 Support
Files.llb directory.

Inputs/Outputs
• Temperature Units (C) —

Temperature Units is the units of temperature the VI outputs.

This input accepts the following values.

0 Celsius
1 Fahrenheit
2 Kelvin
3 Rankine

• Thermocouple Voltage —

Thermocouple Voltage is the voltage read from a thermocouple.

• ThermocoupleType —

ThermocoupleType can be B, E, J, K, R, S, T, or N.

This input accepts the following values. Refer to your thermocouple user manual for more
information about thermocouple types.

0 B
1 E
2 J
3 K

© National Instruments 613


Functions

4 R
5 S
6 T
7 N

• CJC Voltage —

CJC Voltage is the cold-junction compensation reference voltage. The CJC Voltage parameter is
either the IC sensor or the thermistor sensor, as specified by CJC Sensor.

• CJC Sensor(0) —

CJC Sensor is the type of cold-junction compensation sensor you are using.

A CJC Sensor value of 0 selects the IC sensor. A CJC Sensor value of 1 selects the thermistor
sensor.

• Type of Excitation —

Type of Excitation indicates the voltage and current reference.

This input accepts the following values.

0 Voltage Reference
1 Current Reference

• Linearized Temperature —

Linearized Temperature returns the linearized temperature value in the units specified in
Temperature Units.

Radians to Degrees

Converts data from radians to degrees.

This VI is a preconfigured Expression Node.

614 ni.com
Functions

Inputs/Outputs
• —

• —

Degrees to Radians

Converts data from degrees to radians.

This VI is a preconfigured Expression Node.

Inputs/Outputs
• —

• —

RPM to Radians per Second

Converts data from revolutions per minute (RPM) to radians per second.

This VI is a preconfigured Expression Node.

Inputs/Outputs
• —

• —

© National Instruments 615


Functions

Radians per Second to RPM

Converts data from radians per second to revolutions per minute (RPM).

This VI is a preconfigured Expression Node.

Inputs/Outputs
• —

• —

Numeric Constant

Use the numeric constant to pass a numeric value to the block diagram. Set this value
by clicking inside the constant with the Operating tool and typing a value.

If you enter a floating-point number for the numeric constant, the default
representation is a double-precision, floating-point number. If you enter an integer,
the default representation is a 32-bit integer. If you enter a complex number, the
default representation is a double-precision, complex number. For example, if you
enter 123, the representation is a 32-bit integer. If you enter 123., the representation is
a double-precision, floating-point number. You also can change the numeric
representation of a numeric constant.

You cannot change the value of the numeric constant while the VI runs. You can assign
a label to this constant.

Enum Constant

Use the enumerated constant to create a list of string labels with corresponding
integer values you can select on the block diagram.

616 ni.com
Functions

The enumerated constant is similar to a ring constant, but you cannot customize the
corresponding numeric values for the string labels in an enumerated constant. The
numeric value is always an integer from zero to n – 1, where n is the number of values
in the enumerated constant.

Unlike the ring constant, the labels associated with an integer value are part of the
data type. If you pass the value from an enumerated constant to an indicator, LabVIEW
displays the string label instead of the numeric value.

The enumerated constant is only visible on the block diagram and cannot be viewed
on the front panel. You also cannot change its value at run time, so you should select a
value from the enumerated constant before you run the VI. Use an enumerated type
control to allow the user to select an enumerated value from the front panel at run
time.

You select, add or remove, and rearrange values in enumerated constants much the
same way you do for ring and enumerated controls.

By default, the numeric representation of an enumerated constant is a 16-bit unsigned


integer. You can change the representation of an enumerated constant to any unsigned
integer data type except for an unsigned 64-bit integer data type.

Ring Constant

Use the ring constant to create a list of value pairs you can select on the block diagram.
Each value pair consists of a numeric value and corresponding string label.

The ring constant is similar to an enumerated constant, but you can customize the
corresponding numeric values for the string labels in a ring constant. You also can
rearrange the order of the value pairs without changing their numeric values.

If you pass the value from a ring constant to an indicator, LabVIEW displays the
numeric value instead of the string label associated with it.

You select, add or remove, and rearrange values in ring constants much the same way

© National Instruments 617


Functions

you do for ring and enumerated controls.

By default, the numeric representation of a ring constant is a 16-bit unsigned integer.


You can change the representation of a ring constant to any numeric data type except
complex.

Random Number (0-1) Function

Produces a double-precision, floating-point number between 0 and 1. The number


generated is greater than or equal to 0, but less than 1. The distribution is uniform.

Alternatively, you can use several of the Signal Generation VIs or the Signal Generation
PtByPt VIs to regenerate the same random sequence. For example, the Uniform White
Noise VI allows you to set a seed number that you can use to initialize the generation
of a pseudorandom pattern.

Inputs/Outputs
• number (0 to 1) —

number (0 to 1) is a double-precision, floating-point number between 0 and 1.

Random Number (Range)

Generates a random value from a specified range. Wire data to the upper bound or
lower bound input to determine the polymorphic instance to use or manually select
the instance.

618 ni.com
Functions

• Random Number (Range) U64 VI


• Random Number (Range) I64 VI
• Random Number (Range) DBL VI

Random Number (Range) U64 VI

Generates a random value from a specified range. Wire data to the upper bound or
lower bound input to determine the polymorphic instance to use or manually select
the instance.

Inputs/Outputs
• upper bound (100) —

upper bound specifies the upper limit of the range. The default is 100.

• lower bound (0) —

lower bound specifies the lower limit of the range. The default is 0.

• number —

number returns a random number greater than or equal to lower bound and less than or equal
to upper bound.

If upper bound is less than or equal to lower bound, this output returns lower bound.

Random Number (Range) I64 VI

Generates a random value from a specified range. Wire data to the upper bound or
lower bound input to determine the polymorphic instance to use or manually select
the instance.

© National Instruments 619


Functions

Inputs/Outputs
• upper bound (100) —

upper bound specifies the upper limit of the range. The default is 100.

• lower bound (-100) —

lower bound specifies the lower limit of the range. The default is -100.

• number —

number returns a random number greater than or equal to lower bound and less than or equal
to upper bound.

If upper bound is less than or equal to lower bound, this output returns lower bound.

Random Number (Range) DBL VI

Generates a random value from a specified range. Wire data to the upper bound or
lower bound input to determine the polymorphic instance to use or manually select
the instance.

Inputs/Outputs
• upper bound (100) —

upper bound specifies the upper limit of the range. The default is 100.

• lower bound (0) —

lower bound specifies the lower limit of the range. The default is 0.

• number —

number returns a random number greater than or equal to lower bound and less than upper
bound.

620 ni.com
Functions

If upper bound is less than or equal to lower bound, this output returns lower bound.

Fixed-Point

Use the Fixed-Point functions to manipulate the overflow status of a fixed-point


number.

Palette
Description
Object
Fixed-Point
Scales the fixed-point input to produce an integer output. This function is the
to Integer
equivalent of an arithmetic shift of the input, constrained so that the least significant
Cast
bit of the input becomes the least significant bit of the output.
Function
Integer to Scales the integer input to produce an output with the requested fixed-point type.
Fixed-Point This function is the equivalent of an arithmetic shift of the input with configurable
Cast overflow handling, constrained so that the least significant bit of the input becomes
Function the least significant bit of the output.
Clear Fixed-
Point
Overflow Clears the overflow status of FXP by changing the overflow status of FXP to FALSE.
Status
Function
Remove
Fixed-Point
Overflow Removes the overflow status from FXP.
Status
Function
Include
Fixed-Point
Includes an overflow status with FXP. The value of the overflow status equals the
Overflow
value specified in overflow.
Status
Function

© National Instruments 621


Functions

Fixed-Point to Integer Cast Function

Scales the fixed-point input to produce an integer output. This function is the
equivalent of an arithmetic shift of the input, constrained so that the least significant
bit of the input becomes the least significant bit of the output.

Inputs/Outputs
• fixed-point —

fixed-point is the data you want to scale. fixed-point can be any fixed-point data type.

• integer —

integer is the input data scaled to the smallest compatible integer type that prevents overflow.
This output discards the overflow status.

If fixed-point is a signed number, LabVIEW sign-extends the input data as necessary to


ensure that the input and output data are always the same sign.

Note The Fixed-Point to Integer Cast function combines elements of the


Scale by Power of 2 function and the Type Cast function. The Fixed-Point to
Integer Cast function performs an operation that reinterprets the bits, like a
cast, but also implements an arithmetic shift with sign extension, similar to
the Scale by Power of 2.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Fixed-Point Cast.vi

622 ni.com
Functions

Integer to Fixed-Point Cast Function

Scales the integer input to produce an output with the requested fixed-point type. This
function is the equivalent of an arithmetic shift of the input with configurable overflow
handling, constrained so that the least significant bit of the input becomes the least
significant bit of the output.

Inputs/Outputs
• fixed-point type —

fixed-point type is the fixed-point data type to which you want to convert the integer data. You
can configure the fixed-point data type in the Data Type page of the Properties dialog box.
LabVIEW ignores any data in the constant or control that you wire to fixed-point type. You also
can leave this input unwired and configure the output data type in the Output Configuration
page of the Properties dialog box.

• integer —

integer is the data you want to scale. integer can be any integer data type.

• fixed-point —

fixed-point is the input data scaled to the requested fixed-point data type.

If the word length of integer is greater than or less than the word length of fixed-point
type, LabVIEW first converts integer to the integer word length of fixed-point type
before casting integer to the requested fixed-point type. The least significant bit of
integer becomes the least significant bit of fixed-point, so rounding is never
necessary.

To override the default behavior of this function, right-click the function and select
Properties from the shortcut menu to display the Output Configuration page of the
Properties dialog box. You can use this dialog box to configure the output settings of
this function.

© National Instruments 623


Functions

Note The Integer to Fixed-Point Cast function combines elements of the


Conversion functions, the Type Cast function, and the Scale by Power of 2
function. The Integer to Fixed-Point Cast function performs an operation that
reinterprets the bits, like a cast, but also handles the numerical overflow and
sign extension issues that commonly arise when combining integer and fixed-
point algorithms.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Numerics\Fixed-Point Cast.vi

Clear Fixed-Point Overflow Status Function

Clears the overflow status of FXP by changing the overflow status of FXP to FALSE.

Inputs/Outputs
• FXP —

FXP specifies a fixed-point number.

• FXP with overflow cleared —

FXP with overflow cleared returns FXP with an overflow status of FALSE. If FXP does not include
an overflow status, FXP with overflow cleared returns FXP unchanged.

• overflow? —

overflow? is TRUE if FXP includes an overflow status and FXP is the result of an operation that
overflowed.

If FXP does not include an overflow status, or if FXP includes an overflow status but is not the
result of an operation that overflowed, overflow? is FALSE.

624 ni.com
Functions

Remove Fixed-Point Overflow Status Function

Removes the overflow status from FXP.

To change the overflow status to FALSE, use the Clear Fixed-Point Overflow Status
function.

Inputs/Outputs
• FXP —

FXP specifies a fixed-point number.

• FXP with overflow removed —

FXP with overflow removed returns FXP without an overflow status. If FXP does not include an
overflow status, FXP with overflow removed returns FXP unchanged.

• overflow? —

overflow? is TRUE if FXP includes an overflow status and FXP is the result of an operation that
overflowed.

If FXP does not include an overflow status, or if FXP includes an overflow status but is not the
result of an operation that overflowed, overflow? is FALSE.

Include Fixed-Point Overflow Status Function

Includes an overflow status with FXP. The value of the overflow status equals the value
specified in overflow.

Inputs/Outputs
• FXP —

© National Instruments 625


Functions

FXP specifies a fixed-point number.

• overflow —

overflow specifies whether the overflow status of FXP with overflow included is TRUE or FALSE.

• FXP with overflow included —

FXP with overflow included returns FXP with an overflow status set to the value specified in
overflow.

DBL Numeric Constant

Use the DBL numeric constant to pass a double-precision, floating-point numeric value
to the block diagram. Set this value by clicking inside the constant with the Operating
tool and typing a value.

If you enter a floating-point number for the numeric constant, the default
representation is a double-precision, floating-point number. For example, if you enter
123, the representation is a 32-bit integer.

You also can change the numeric representation of a numeric constant. If you enter an
integer, the default representation is a 32-bit integer. For example, if you enter 123.,
the representation is a double-precision, floating-point number. If you enter a complex
number, the default representation is a double-precision, complex number.

You cannot change the value of the numeric constant while the VI runs. You can assign
a label to this constant.

Positive Infinity

Returns the value Inf (infinity).

LabVIEW converts Inf to the highest value for a data type. For example, converting Inf

626 ni.com
Functions

to a 16-bit signed integer returns the value 32,767, the highest possible value for a
16-bit signed integer.

Machine Epsilon

Represents the round-off error for a floating-point number with a given precision. Use
the machine epsilon constant to compare whether two floating-point numbers are
equivalent.

Not A Number Constant

Returns the value NaN (not a number).

You can change the numeric representation of this constant by right-clicking the
constant and selecting Representation from the shortcut menu. You also can assign a
label to this constant.

Math & Scientific Constants

Use the Math & Scientific Constants to create LabVIEW applications.

Palette Object Description


Pi Returns the value 3.1415926535897932.
Pi Multiplied By 2 Returns the value 6.2831853071795865.

© National Instruments 627


Functions

Palette Object Description


Pi Divided By 2 Returns the value 1.5707963267948966.
Reciprocal Of Pi Returns the value 0.31830988618379067.
Natural Logarithm Of Pi Returns the value 1.1447298858494002.
Natural Logarithm Base Returns the value 2.7182818284590452.
Reciprocal Of e Returns the value 0.36787944117144232.
Base 10 Logarithm Of e Returns the value 0.43429448190325183.
Natural Logarithm Of 10 Returns the value 2.3025850929940597.
Natural Logarithm Of 2 Returns the value 0.69314718055994531.
Planck's Constant (J/Hz) Returns the value 6.62607015e-34.
Elementary Charge (C) Returns the value 1.602176634e-19.
Speed Of Light In Vacuum (m/sec) Returns the value 299792458.
Gravitational Constant (N m2/kg2) Returns the value 6.67430e-11.
Avogadro Constant (1/mol) Returns the value 6.02214076e23.
Rydberg Constant (1/m) Returns the value 10973731.568160.
Molar Gas Constant (J/(mol K)) Returns the value 8.314462618.

Range Limits for Type

Returns the maximum and minimum values of the input data type.

Inputs/Outputs
• type —

type specifies the data type.

This input accepts any scalar numeric data type and enum.

• maximum value for type —

628 ni.com
Functions

maximum value for type returns the maximum value of the data type wired to type. If type is an
enum, this VI returns the last value of the enum.

For example, if type is a 16-bit unsigned integer, this output returns 32767. If type is an enum
with values {cat, dog, bird}, this output returns bird.

• minimum value for type —

minimum value for type returns the minimum value of the data type wired to type. If type is an
enum, this VI returns the first value of the enum.

For example, if type is a 16-bit unsigned integer, this output returns -32768. If type is an enum
with values {cat, dog, bird}, this output returns cat.

Expression Node

Use the Expression Node to calculate expressions that contain a single variable. The
following built-in functions are allowed in formulas: abs, acos, acosh, asin, asinh, atan,
atanh, ceil, cos, cosh, cot, csc, exp, expm1, floor, getexp, getman, int, intrz, ln, lnp1, log,
log2, max, min, mod, rand, rem, sec, sign, sin, sinc, sinh, sizeOfDim, sqrt, tan, tanh.

Inputs/Outputs
• —

input is the value that the Expression Node uses as the variable.

• —

output returns the value of the calculation.

Expression Nodes are useful when an expression has only one variable but is otherwise
complicated. Use the correct syntax, operators, and functions when creating
Expression Nodes.

Expression Nodes have the following restrictions:

© National Instruments 629


Functions

• Expression Nodes accept any non-complex numeric data type.


• Expression Nodes accept only the period (.) as a decimal separator. The nodes do
not recognize localized decimal separators.
• Expression Nodes accept only pi as a constant. The constant is case-sensitive.
• You cannot add Expression Nodes to a VI on which you enable inlining.

Boolean
Use the Boolean functions to perform logical operations on single Boolean values or
arrays of Boolean values.

Palette
Description
Object
Computes the logical AND of the inputs. Both inputs must be Boolean values, numeric
And
values, or error clusters. If both inputs are TRUE, the function returns TRUE. Otherwise,
Function
it returns FALSE.
Computes the logical OR of the inputs. Both inputs must be Boolean values, numeric
Or
values, or error clusters. If both inputs are FALSE, the function returns FALSE.
Function
Otherwise, it returns TRUE.
Exclusive Computes the logical exclusive or (XOR) of the inputs. Both inputs must be Boolean
Or values, numeric values, or error clusters. If both inputs are TRUE or both inputs are
Function FALSE, the function returns FALSE. Otherwise, it returns TRUE.
Not Computes the logical negation of the input. If x is FALSE, the function returns TRUE. If x
Function is TRUE, the function returns FALSE.

Performs arithmetic on one or more numeric, array, cluster, or Boolean inputs. To


Compound select the operation (Add, Multiply, AND, OR, or XOR), right-click the function and
Arithmetic select Change Mode from the shortcut menu. When you select this function from the
VI Numeric palette, the default mode is Add. When you select this function from the
Boolean palette, the default mode is OR.

Computes the logical NAND of the inputs. Both inputs must be Boolean values,
Not And
numeric values, or error clusters. If both inputs are TRUE, the function returns FALSE.
Function
Otherwise, it returns TRUE.

630 ni.com
Functions

Palette
Description
Object
Computes the logical NOR of the inputs. Both inputs must be Boolean values, numeric
Not Or
values, or error clusters. If both inputs are FALSE, the function returns TRUE.
Function
Otherwise, it returns FALSE.
Not
Computes the logical negation of the logical exclusive or (XOR) of the inputs. Both
Exclusive
inputs must be Boolean values, numeric values, or error clusters. If both inputs are
Or
TRUE or both inputs are FALSE, the function returns TRUE. Otherwise, it returns FALSE.
Function
Negates x and then computes the logical OR of y and the negated x. Both inputs must
Implies
be Boolean values, numeric values, or error clusters. If x is TRUE and y is FALSE, the
Function
function returns FALSE. Otherwise, it returns TRUE.
And Array Returns TRUE if all the elements in Boolean array are TRUE or if Boolean array is
Elements empty. Otherwise, the function returns FALSE. This function accepts an array of any
Function size but returns only a single value based on all values in Boolean array.
Or Array Returns FALSE if all the elements in Boolean array are FALSE or if Boolean array is
Elements empty. Otherwise, the function returns TRUE. This function accepts an array of any
Function size but returns only a single value based on all values in Boolean array.
Converts an integer or fixed-point number to a Boolean array. If you wire an integer to
Number To number, Boolean array returns an array of 8, 16, 32, or 64 elements, depending on the
Boolean number of bits in the integer. If you wire a fixed-point number to number, the size of
Array the array that Boolean array returns equals the word length of the fixed-point number.
Function The 0th element of the array corresponds to the least significant bit of the two's
complement representation of the integer.
Boolean
Converts a Boolean array to an integer or a fixed-point number by interpreting the
Array To
array as the binary representation of the number. The first element of the array
Number
corresponds to the least significant bit in the number.
Function
Boolean To
Converts a Boolean FALSE or TRUE value to a 16-bit integer with a value of 0 or 1,
(0,1)
respectively.
Function

True
Use this constant to provide a value of TRUE to the block diagram.
Constant

False
Use this constant to provide a value of FALSE to the block diagram.
Constant

© National Instruments 631


Functions

And Function

Computes the logical AND of the inputs. Both inputs must be Boolean values, numeric
values, or error clusters. If both inputs are TRUE, the function returns TRUE. Otherwise,
it returns FALSE.

Note This function performs bitwise operations on numeric inputs.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x must be a Boolean value or a number.x can be a scalar, array or cluster of numbers or Boolean
values, array of clusters of numbers or Boolean values, and so on. If x is an error cluster, only the
status parameter of the error cluster passes to the input terminal.

• y—

y must be a Boolean value or a number. y can be a scalar, array or cluster of numbers or Boolean
values, arrays of clusters of numbers or Boolean values, and so on. If y is an error cluster, only
the status parameter of the error cluster passes to the input terminal.

• x .and. y? —

x .and. y? is the logical AND of x and y.

And Truth Table

x y x .and. y?
T T T
T F F

632 ni.com
Functions

x y x .and. y?
F T F
F F F

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

Or Function

Computes the logical OR of the inputs. Both inputs must be Boolean values, numeric
values, or error clusters. If both inputs are FALSE, the function returns FALSE.
Otherwise, it returns TRUE.

Note This function performs bitwise operations on numeric inputs.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x must be a Boolean value or a number. x can be a scalar, array or cluster of numbers or Boolean
values, array of clusters of numbers or Boolean values, and so on. If x is an error cluster, only the
status parameter of the error cluster passes to the input terminal.

• y—

y must be a Boolean value or a number. y can be a scalar, array or cluster of numbers or Boolean
values, arrays of clusters of numbers or Boolean values, and so on. If y is an error cluster, only
the status parameter of the error cluster passes to the input terminal.

© National Instruments 633


Functions

• x .or. y? —

x .or. y? is the logical Or of x and y.

Or Truth Table

x y x .or. y?
T T T
T F T
F T T
F F F

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

Exclusive Or Function

Computes the logical exclusive or (XOR) of the inputs. Both inputs must be Boolean
values, numeric values, or error clusters. If both inputs are TRUE or both inputs are
FALSE, the function returns FALSE. Otherwise, it returns TRUE.

Note This function performs bitwise operations on numeric inputs.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

634 ni.com
Functions

x must be a Boolean value or a number.x can be a scalar, array or cluster of numbers or Boolean
values, array of clusters of numbers or Boolean values, and so on. If x is an error cluster, only the
status parameter of the error cluster passes to the input terminal.

• y—

y must be a Boolean value or a number.y can be a scalar, array or cluster of numbers or Boolean
values, arrays of clusters of numbers or Boolean values, and so on. If y is an error cluster, only
the status parameter of the error cluster passes to the input terminal.

• x .xor. y? —

x .xor. y? is the logical exclusive or (XOR) of x and y.

Exclusive Or Truth Table

x y x .xor. y?
T T F
T F T
F T T
F F F

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

Not Function

Computes the logical negation of the input. If x is FALSE, the function returns TRUE. If x
is TRUE, the function returns FALSE.

Note This function performs bitwise operations on numeric inputs.

© National Instruments 635


Functions

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a scalar Boolean value or number, array or cluster of Boolean values or numbers, array
of clusters of Boolean values or numbers, and so on. If x is an error cluster, only the status
parameter of the error cluster passes to the input terminal.

• .not. x? —

.not. x? is the logical negation of x.

Not Truth Table

x .not. x?
F T
T F

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

Not And Function

Computes the logical NAND of the inputs. Both inputs must be Boolean values,
numeric values, or error clusters. If both inputs are TRUE, the function returns FALSE.
Otherwise, it returns TRUE.

Note This function performs bitwise operations on numeric inputs.

636 ni.com
Functions

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x must be a Boolean value or a number. x can be a scalar, array or cluster of numbers or Boolean
values, array of clusters of numbers or Boolean values, and so on. If x is an error cluster, only the
status parameter of the error cluster passes to the input terminal.

• y—

y must be a Boolean value or a number. y can be a scalar, array or cluster of numbers or Boolean
values, arrays of clusters of numbers or Boolean values, and so on. If y is an error cluster, only
the status parameter of the error cluster passes to the input terminal.

• .not. (x .and. y)? —

.not. (x .and. y)? is the logical NAND of x and y.

Not And Truth Table

x y .not. (x .and. y)?


T T F
T F T
F T T
F F T

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

© National Instruments 637


Functions

Not Or Function

Computes the logical NOR of the inputs. Both inputs must be Boolean values, numeric
values, or error clusters. If both inputs are FALSE, the function returns TRUE.
Otherwise, it returns FALSE.

Note This function performs bitwise operations on numeric inputs.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x must be a Boolean value or a number. x can be a scalar, array or cluster of numbers or Boolean
values, array of clusters of numbers or Boolean values, and so on. If x is an error cluster, only the
status parameter of the error cluster passes to the input terminal.

• y—

y must be a Boolean value or a number. y can be a scalar, array or cluster of numbers or Boolean
values, arrays of clusters of numbers or Boolean values, and so on. If y is an error cluster, only
the status parameter of the error cluster passes to the input terminal.

• .not. (x .or. y)? —

.not. (x .or. y)? is the logical NOR of x and y.

Not Or Truth Table

x y .not. (x .or. y)?


T T F
T F F

638 ni.com
Functions

x y .not. (x .or. y)?


F T F
F F T

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

Not Exclusive Or Function

Computes the logical negation of the logical exclusive or (XOR) of the inputs. Both
inputs must be Boolean values, numeric values, or error clusters. If both inputs are
TRUE or both inputs are FALSE, the function returns TRUE. Otherwise, it returns FALSE.

Note This function performs bitwise operations on numeric inputs.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x must be a Boolean value or a number. x can be a scalar, array or cluster of numbers or Boolean
values, array of clusters of numbers or Boolean values, and so on. If x is an error cluster, only the
status parameter of the error cluster passes to the input terminal.

• y—

y must be a Boolean value or a number. y can be a scalar, array or cluster of numbers or Boolean
values, arrays of clusters of numbers or Boolean values, and so on. If y is an error cluster, only
the status parameter of the error cluster passes to the input terminal.

© National Instruments 639


Functions

• .not. (x .xor. y)? —

.not. (x .xor. y)? is the logical negation of the logical exclusive or (XOR) of x and y.

Not Exclusive Or Truth Table>

x y .not. (x .xor. y)?


T T T
T F F
F T F
F F T

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

Implies Function

Negates x and then computes the logical OR of y and the negated x. Both inputs must
be Boolean values, numeric values, or error clusters. If x is TRUE and y is FALSE, the
function returns FALSE. Otherwise, it returns TRUE.

Note This function performs bitwise operations on numeric inputs.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

640 ni.com
Functions

x must be a Boolean value or a number. x can be a scalar, array or cluster of numbers or Boolean
values, array of clusters of numbers or Boolean values, and so on. If x is an error cluster, only the
status parameter of the error cluster passes to the input terminal.

• y—

y must be a Boolean value or a number. y can be a scalar, array or cluster of numbers or Boolean
values, arrays of clusters of numbers or Boolean values, and so on. If y is an error cluster, only
the status parameter of the error cluster passes to the input terminal.

• x .implies. y? —

x .implies. y? is the logical OR of y and of the logical negation of x.

Implies Truth Table

x y x .implies. y?
T T T
T F F
F T T
F F T

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Booleans\Boolean Functions.vi

And Array Elements Function

Returns TRUE if all the elements in Boolean array are TRUE or if Boolean array is
empty. Otherwise, the function returns FALSE. This function accepts an array of any
size but returns only a single value based on all values in Boolean array.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 641


Functions

Inputs/Outputs
• Boolean array —

Boolean array can have any number of dimensions.

• logical AND —

logical AND indicates if all elements in Boolean array are TRUE.

Or Array Elements Function

Returns FALSE if all the elements in Boolean array are FALSE or if Boolean array is
empty. Otherwise, the function returns TRUE. This function accepts an array of any size
but returns only a single value based on all values in Boolean array.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• Boolean array —

Boolean array can have any number of dimensions.

• logical OR —

logical OR indicates if all of the elements in Boolean array are false.

Number To Boolean Array Function

Converts an integer or fixed-point number to a Boolean array. If you wire an integer to


number, Boolean array returns an array of 8, 16, 32, or 64 elements, depending on the

642 ni.com
Functions

number of bits in the integer. If you wire a fixed-point number to number, the size of
the array that Boolean array returns equals the word length of the fixed-point number.
The 0th element of the array corresponds to the least significant bit of the two's
complement representation of the integer.

Inputs/Outputs
• number —

number can be a number.

• Boolean array —

Boolean array can have 8, 16, 32, or 64 elements if number is an integer. If number is a fixed-
point number, Boolean array can have between 1 and 64 elements.

If you wire a fixed-point number that includes an overflow status to number, this
function ignores the overflow status and converts only the number to a Boolean array.

Boolean Array To Number Function

Converts a Boolean array to an integer or a fixed-point number by interpreting the


array as the binary representation of the number. The first element of the array
corresponds to the least significant bit in the number.

Inputs/Outputs
• Boolean array —

Boolean array is a one-dimensional array of Boolean values.

This function truncates Boolean array if it is too long. If Boolean array is too short, this function

© National Instruments 643


Functions

pads Boolean array according to the Sign Extension Mode you can select by right-clicking the
function.

• Never —This function pads Boolean array with Boolean FALSE bits.
• If Output Is Signed —(default) For an output with an unsigned representation, this function
pads Boolean array with Boolean FALSE bits. For an output with a signed representation,
this function pads Boolean array with the last element of the array.
• Always —This function pads Boolean array with the last element of the array.
• number —

number is an integer or a fixed-point number.

You can change the numeric representation of number on the Output Configuration page of the
Properties dialog box. Right-click the function and select Properties to display the Properties
dialog box.

The following table shows the relationship between Boolean array and number.

Output Sign Extension Binary


Boolean array number
Representation Mode Value
{FALSE, TRUE} I8 If Output Is Signed 11111110 -2
{FALSE, TRUE} U8 If Output Is Signed 00000010 2
{FALSE, TRUE, FALSE, TRUE} I8 Always 11111010 -6
{FALSE, TRUE, FALSE, TRUE} I8 Never 00001010 10
{FALSE, FALSE, TRUE, FALSE,
U8 If Output Is Signed 00010100 20
TRUE}
{FALSE, FALSE, TRUE, FALSE,
U8 Always 11110100 244
TRUE}

Boolean To (0,1) Function

Converts a Boolean FALSE or TRUE value to a 16-bit integer with a value of 0 or 1,


respectively.

644 ni.com
Functions

Inputs/Outputs
• Boolean —

Boolean can be a scalar, an array, a cluster of Boolean values, an array of clusters of Boolean
values, and so on. If Boolean is an error cluster, only the status parameter of the error cluster
passes to the input terminal.

• 0, 1 —

0, 1 is 0 if Boolean is FALSE and 1 if Boolean is TRUE.

True Constant

Use this constant to provide a value of TRUE to the block diagram.

You can assign a label to this constant by right-clicking the constant and selecting
Visible Items»Label from the shortcut menu.

You can change this value to FALSE by using the Operating tool to click the T portion of
the constant or by right-clicking the constant and selecting Data Operations»Change
Value to False from the shortcut menu. You cannot change this value while the VI runs.

False Constant

Use this constant to provide a value of FALSE to the block diagram.

You can assign a label to this constant by right-clicking the constant and selecting
Visible Items»Label from the shortcut menu.

You can change this value to TRUE by using the Operating tool to click the F portion of
the constant or by right-clicking the constant and selecting Data Operations»Change
Value to True from the shortcut menu. You cannot change this value while the VI runs.

© National Instruments 645


Functions

String
Use the String functions to concatenate two or more strings, extract a subset of strings
from a string, convert data into strings, and format a string for use in a word processing
or spreadsheet application.

Palette
Description
Object
String
Length Returns in length the number of characters (bytes) in string.
Function
Concatenate Concatenates input strings and 1D arrays of strings into a single output string. For
Strings array inputs, this function concatenates each element of the array.
String
Returns the substring of the input string beginning at offset and containing length
Subset
number of characters.
Function

Removes all ASCII white space (spaces, tabs, carriage returns, and linefeeds) from the
Trim
beginning, end, or both ends of string. The Trim Whitespace VI does not remove
Whitespace
double byte characters.

Converts the line endings of the input string to the line ending format you specify. If
Normalize you do not specify a line ending format, this VI converts the line endings of the string
End Of Line to the line endings that the current platform expects. Use this VI to make your strings
readable by different platforms or by the command line of the current platform.

Replace
Substring Inserts, deletes, or replaces a substring at the offset you specify in string.
Function
Search and Replaces one or all instances of a substring with another substring. To include the

646 ni.com
Functions

Palette
Description
Object
Replace
multiline? input and enable advanced regular expression searches, right-click the
String
function and select Regular Expression.
Function
Searches for regular expression in string beginning at offset. If the function finds a
Match match, it splits string into three substrings. A regular expression requires a specific
Pattern combination of characters for pattern matching. This function gives you fewer
Function options for matching strings but performs more quickly than the Match Regular
Expression function.

Searches for a regular expression in the input string beginning at the offset you
Match
enter. If the function finds a match, it splits the string into three substrings and any
Regular
number of submatches. Resize the function to view any submatches found in the
Expression
string.

Path/Array/
String Use the Path/Array/String Conversion functions to convert strings, arrays, and paths.
Conversion
Scan From
Scans the input string and converts the string according to format string.
String
Format Into
Formats string, path, enumerated type, time stamp, Boolean, or numeric data as text.
String
Format
Date/Time Displays a timestamp value or a numeric value as time in the format you specify
String using time format codes.
Function

Creates an output string from a combination of text and parameterized inputs. If the
Build Text input is not a string, this Express VI converts the input into a string based on the
configuration of the Express VI.

Number/
String Use the String/Number Conversion functions to convert strings.
Conversion
Spreadsheet
Converts the spreadsheet string to an array of the dimension and representation of
String To
array type. This function works for arrays of strings and arrays of numbers.
Array

© National Instruments 647


Functions

Palette
Description
Object
Function
Array To
Converts an array of any dimension to a table in string form, containing tabs
Spreadsheet
separating column elements, a platform-dependent EOL character separating rows,
String
and, for arrays of three or more dimensions, headers separating pages.
Function
To Upper Converts all alphabetic characters in string to uppercase characters. Evaluates all
Case numbers in string as ASCII codes for characters. This function does not affect non-
Function alphabetic characters.
To Lower Converts all alphabetic characters in string to lowercase characters. Evaluates all
Case numbers in string as ASCII codes for characters. This function does not affect non-
Function alphabetic characters.

Flatten/
Use the Flatten/Unflatten String functions to flatten and unflatten LabVIEW data
Unflatten
types to and from strings.
String

String
Use this constant to supply a constant text string to the block diagram.
Constant
Empty
String Consists of a constant string that is empty (length zero).
Constant

Space
Use this constant to supply a one-character space string to the block diagram.
Constant

Tab
Consists of a constant string containing the ASCII HT (horizontal tab) value.
Constant

Additional
Use the Additional String VIs and functions to scan and search in strings, match
String
patterns, and manipulate strings.
Functions

Carriage
Return Consists of a constant string containing the ASCII CR value.
Constant
Line Feed
Consists of a constant string containing the ASCII LF value.
Constant
End of Line Consists of a constant string containing the platform-dependent end-of-line value.

648 ni.com
Functions

Palette
Description
Object
Constant

String Length Function

Returns in length the number of characters (bytes) in string.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string —

string can be a string or any data structure that contains only strings, such as an array or clusters
of strings.

• length —

length has the same structure as string.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Strings\String Length.vi

Concatenate Strings

Concatenates input strings and 1D arrays of strings into a single output string. For
array inputs, this function concatenates each element of the array.

Add inputs to the function by right-clicking an input and selecting Add Input from the
shortcut menu or by resizing the function.

© National Instruments 649


Functions

Inputs/Outputs
• string —

string 0..n-1 are the strings you want to concatenate.

• string —

• concatenated string —

concatenated string contains the concatenated input strings in the order you wire them to the
node from top to bottom.

You can use this function to concatenate the output from Picture Functions VIs so that
they draw on a single picture control. The pictures are drawn in order from top to
bottom.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Strings\Concatenate Strings.vi

String Subset Function

Returns the substring of the input string beginning at offset and containing length
number of characters.

The connector pane displays the default data types for this polymorphic function.

650 ni.com
Functions

Inputs/Outputs
• string —

string is the input string.

• offset (0) —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric.

The offset of the first character in string is 0. If offset is unwired or less than 0, the function takes
offset as 0.
• length (rest) —

length must be numeric. If length is left unwired, the default is the length of string minus offset.

• substring —

substring is empty if offset is greater than the length of the string or if the length is less than or
equal to 0.

If length is greater than or equal to the length of string minus offset, substring is the remainder
of string beginning at offset.

Trim Whitespace

Removes all ASCII white space (spaces, tabs, carriage returns, and linefeeds) from the
beginning, end, or both ends of string. The Trim Whitespace VI does not remove
double byte characters.

The default is to remove white space from both ends of string.

Inputs/Outputs
• location (both) —

© National Instruments 651


Functions

location determines if this function removes white space from the beginning, end, or both ends
of string.

The default is both.

0 Both—Removes white space from both ends of the input string.


1 Start of string—Removes white space from the start of the input string.
2 End of string—Removes white space from the end of the input string.

• string —

string is the input string.

• trimmed string —

trimmed string contains the string with the white space removed.

Normalize End Of Line

Converts the line endings of the input string to the line ending format you specify. If
you do not specify a line ending format, this VI converts the line endings of the string
to the line endings that the current platform expects. Use this VI to make your strings
readable by different platforms or by the command line of the current platform.

For example, if you specify UNIX in end of line, LabVIEW converts the line endings of
string in to \n because \n is the standard UNIX line ending.

Inputs/Outputs
• end of line (Native) —

end of line specifies the line ending to which to convert.

652 ni.com
Functions

Note In LabVIEW for macOS, Native and Native Command Line are equivalent to
UNIX. In LabVIEW for OS X 32-bit, Native and Native Command Line are equivalent to
Macintosh.

0 Native—Specifies the native line ending of the current platform.


Native Command Line—Specifies the native line ending of the command line of the current
1
platform.
2 UNIX—Specifies the UNIX line ending, used by Linux, macOS, and other UNIX derivatives, \n.
3 Macintosh—Specifies the Macintosh Classic line ending, \r.
4 DOS—Specifies the standard DOS/Windows line ending, \r\n.

• string in —

string in specifies the string containing the line endings you want to convert.

• string out —

string out returns the string with converted line endings.

Replace Substring Function

Inserts, deletes, or replaces a substring at the offset you specify in string.

Inputs/Outputs
• string —

string is the string in which you want to replace characters.

• substring ("") —

substring contains the substring that replaces length characters at offset in string.

• offset (0) —

© National Instruments 653


Functions

offset determines the number of characters into string at which the function places substring.

• length (len. of substring) —

length determines the number of characters in string to replace with substring.

If substring is empty, length characters are deleted starting at offset.


• result string —

result string contains the edited string with the replaced characters.

• replaced substring —

replaced substring contains the characters that were replaced in string.

The Replace Substring function deletes length characters in string starting at offset,
and replaces the deleted portion with substring. If length is 0, the Replace Substring
function inserts substring at offset. If substring is empty, the Replace Substring
function deletes length characters at offset.

Search and Replace String Function

Replaces one or all instances of a substring with another substring. To include the
multiline? input and enable advanced regular expression searches, right-click the
function and select Regular Expression.

Inputs/Outputs
• multiline? (F) —

multiline? specifies whether to treat the text in input string as a multiple-line string. This setting

654 ni.com
Functions

affects how the ^ and $ characters handle matches.

If you set multiline? to FALSE (default), when you enter ^ at the beginning of a regular
expression, the expression matches only the beginning of the string in input string. When you
enter $ at the end of a regular expression, the expression matches only the end of the string in
input string. If you set multiline? to TRUE, ^ matches the beginning of any line in input string
and $ matches the end of any line in input string.

Note The ^ character anchors the match to the beginning of a string when used as
the first character of a pattern. If you add ^ to the beginning of a character class
immediately after an open square bracket, the expression matches any character not
in a given character class.

• ignore case? (F) —

ignore case? specifies whether the string search is case sensitive.

If FALSE (default), the string search is case sensitive.

• replace all? (F) —

replace all? specifies whether the function replaces all occurrences of the search string or only
the first occurrence.

If FALSE (default), the function replaces only the first occurrence.

• input string —

input string specifies the input string you want the function to search.

• search string —

search string specifies the string you want to search for and replace.

If search string is an empty string and replace all? is FALSE, the function inserts replace string at
the beginning of input string. If search string is an empty string and replace all? is TRUE, the
function inserts replace string at the beginning, in between each character, and at the end of
input string.

To search using advanced regular expressions, right-click the function and select Regular
Expression.

• replace string ("") —

© National Instruments 655


Functions

replace string specifies the string you want to insert in place of search string. The default is an
empty string.

To configure the Search and Replace String function to accept backreferences in replace string,
right-click the function and select Regular Expression.

• offset (0) —

offset determines the number of characters into input string at which the function starts
searching for search string.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• result string —

result string contains the input string with one or all occurrences of search string replaced with
replace string.

If replace string is empty, result string contains input string with search string deleted.

• number of replacements —

number of replacements returns the number of times LabVIEW replaced search string.

• offset past replacement —

offset past replacement indicates the offset in result string of the character immediately
following where the last match and replacement occurred.

If replace all? is FALSE, the next match, if any, is after this point.

If the function does not find search string, offset past replacement returns –1.

• error out —

error out contains error information. This output provides standard error out functionality.

Note The Search and Replace String function does not support null
characters in strings. If you include null characters in the strings you wire to

656 ni.com
Functions

this function, LabVIEW returns an error and the function may return
unexpected results.

If you want to search for more complex patterns, such as patterns that contain
character grouping, alternate pattern matching, backreferences, or non-greedy
quantification, configure the function for advanced regular expression searches or use
the Match Regular Expression function.

To search for matches using advanced regular expressions in search string and partial
match substitution in replace string, right-click the Search and Replace String function
and select Regular Expression from the shortcut menu. This function uses the same
regular expression syntax as the Match Regular Expression function.

Regular expression support is provided by the PCRE library package. Refer to the
<National Instruments>\_Legal Information directory for more
information about the license under which the PCRE library package is redistributed.

Refer to the PCRE website at www.pcre.org for more information about Perl
Compatible Regular Expressions.

Match Pattern Function

Searches for regular expression in string beginning at offset. If the function finds a
match, it splits string into three substrings. A regular expression requires a specific
combination of characters for pattern matching. This function gives you fewer options
for matching strings but performs more quickly than the Match Regular Expression
function.

The Match Pattern function is compatible with a limited set of regular expressions and
does not support character grouping, alternate pattern matching, backreferences, or
non-greedy quantification. You can use a specific set of special characters to refine the
search. The connector pane displays the default data types for this polymorphic
function.

© National Instruments 657


Functions

Inputs/Outputs
• string —

string specifies the input string you want the function to search.

• regular expression —

regular expression is the pattern for which you want to search in string. If the function does not
find regular expression, match substring returns an empty string, before substring returns the
entire string, after substring returns an empty string, and offset past match returns –1.

• offset (0) —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric. The offset of the first character in string is 0. If offset is unwired
or less than 0, the function takes offset as 0.

• before substring —

before substring returns a string containing all the characters before the match.

• match substring —

match substring is the matched string.

• after substring —

after substring contains all characters following the matched pattern.

• offset past match —

offset past match returns the index in string of the first character of after substring. If the
function does not find a match, offset past match is –1. The offset input and the offset past
match output might be equal when the empty string is a valid match for the regular expression.
For example, if regular expression is b* and the string input is cdb, offset past match is 0. If
string is bbbcd, offset past match is 3.

This function is similar to the Search and Replace Pattern VI. The Match Pattern

658 ni.com
Functions

function gives you fewer options for matching strings but performs more quickly than
the Match Regular Expression function. For example, the Match Pattern function does
not support the parenthesis or vertical bar (|) characters.

The following table shows examples of regular expressions you can use with this
function. Some of these examples use special characters to refine the search.

Note If you want to include special characters in the search string, you must
enclose each special character in brackets. For example, to search for the
string hz+, enter hz[+] in regular expression. Otherwise, LabVIEW uses the
special character to refine the search.

Characters to Find Regular Expression


VOLTS VOLTS
All uppercase and lowercase versions of volts, that is,
[Vv][Oo][Ll][Tt][Ss]
VOLTS, Volts, volts, and so on
A space, a plus sign, or a minus sign [ +-]
A sequence of one or more digits [0-9]+
[\s*] or [ *] (that is, a space
Zero or more spaces
followed by an asterisk)
One or more spaces, tabs, new lines, or carriage returns [\t \r \n \s]+
One or more characters other than digits [~0-9]+
The word Level only if it begins at the offset position in the
^Level
string
The word Volts only if it appears at the end of the string Volts$
The longest string within parentheses (.*)
The longest string within parentheses but not containing
([~()]*)
any parentheses within it
A left bracket \[
A right bracket \]
cat, dog, cot, dot, cog, and so on. [cd][ao][tg]

© National Instruments 659


Functions

Match Regular Expression

Searches for a regular expression in the input string beginning at the offset you enter.
If the function finds a match, it splits the string into three substrings and any number
of submatches. Resize the function to view any submatches found in the string.

Inputs/Outputs
• multiline? (F) —

multiline? specifies whether to treat the text in input string as a multiple-line string. This setting
affects how the ^ and $ characters handle matches. If you set multiline? to FALSE (default), when
you enter ^ at the beginning of a regular expression, the expression matches only the beginning
of the string in input string. When you enter $ at the end of a regular expression, the expression
matches only the end of the string in input string. If you set multiline? to TRUE, ^ matches the
beginning of any line in input string and $ matches the end of any line in input string.

Note The ^ character anchors the match to the beginning of a string when used as
the first character of a pattern. If you add ^ to the beginning of a character class
immediately after an open square bracket, the expression matches any character not
in a given character class.

• ignore case? (F) —


ignore case? specifies whether the string search is case sensitive. If FALSE (default), the string
search is case sensitive.
• input string —
input string specifies the input string the function searches. This string cannot contain null
characters.
• regular expression —
regular expression specifies the pattern you want to search for in input string. If the function
does not find a match, whole match and after match contain empty strings, before match
contains the entire input string, offset past match returns –1, and all submatches outputs return
empty strings. Place any substrings you want to search for in parentheses. The function returns
any substring expressions it finds in substring 1..n. This string cannot contain null characters.
• offset (0) —
offset specifies the number of characters into input string at which the function starts searching
for search string.
• error in —

660 ni.com
Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.
• before match —
before match returns all the characters before the match.
• whole match —
whole match returns all the characters that match the expression entered in regular expression.
Any substring matches the function finds appear in the submatch outputs.
• after match —
after match returns all the characters after the match.
• offset past match —
offset past match returns the index in input string of the first character after the last match. If
the VI does not find a match, offset past match returns –1.
• error out —
error out contains error information. This output provides standard error out functionality.

Note The Match Regular Expression function does not support null
characters in strings. If you include null characters in strings you wire to this
function, LabVIEW returns an error and the function may return unexpected
results.

Regular expression support is provided by the PCRE library package. Refer to


<National Instruments>\_Legal Information directory for more
information about the license under which the PCRE library package is redistributed.

Refer to the PCRE website at www.pcre.org for more information about Perl
Compatible Regular Expressions.

The Match Regular Expression function gives you more options for matching strings
but performs more slowly than the Match Pattern function.

Use regular expressions in this function to refine searches.

Avoiding Stack Overflow

Certain regular expressions that use repeated grouped expressions (such as (.|\s)*
or (a*)*) require significant resources to process when applied to large input
strings. In some cases a stack overflow may occur on large input strings. Some regular
expressions may recurse repeatedly while attempting to match a large string, which

© National Instruments 661


Functions

may eventually overflow the stack. For example, the regular expression (.|\n)*A
and a large input string may cause LabVIEW to crash. To avoid recursion, you can
rewrite the regular expression (.|\n)*A as (?s).*A. The (?s) notation indicates
that a period matches new lines. You also can rewrite the expression as [^A]*A.

Grouping Patterns for Submatches

You can capture submatches by placing parentheses ( ) around a portion of a regular


expression that you want the function to return as a submatch. For example, the
regular expression (el.)..(L..) returns two submatches in the input string
Hello LabVIEW!: ell and Lab. Each submatch corresponds to a character group
in the order that the character group appears in the regular expression. In this
example, submatch 1 is ell and submatch 2 is Lab.

If you nest a character group within another character group, the regular expression
creates a submatch for the outer group before the inner group. For example, the
regular expression (.(el.).).(L..) returns three submatches in the input Hello
LabVIEW!: Hello, ell, and Lab. In this example, submatch 1 is Hello because
the regular expression matches the outer character group before the inner group.

Examples of Regular Expressions

The following table shows examples of regular expressions you can use with the Match
Regular Expression function.

Characters to Find Regular Expression


VOLTS VOLTS
A plus sign or a minus sign [+-]
A sequence of one or more digits [0-9]+
\s* or * (that is, a space
Zero or more spaces
followed by an asterisk)
One or more spaces, tabs, new lines, or carriage returns [\t \r \n \s]+
One or more characters other than digits [^0-9]+
The word Level only if it appears at the beginning of the string ^Level

662 ni.com
Functions

Characters to Find Regular Expression


The word Volts only if it appears at the end of the string Volts$
The longest string within parentheses \(.*\)
The first string within parentheses but not containing any parentheses
\([^()]*\)
within it
A left bracket \[
A right bracket \]
cat, cag, cot, cog, dat, dag, dot, and dog [cd][ao][tg]
cat or dog cat|dog
dog, cat dog, cat cat dog,cat cat cat dog, and so on ((cat )*dog)
One or more of the letter a followed by a space and the same number
(a+) \1
of the letter a, that is, a a, aa aa, aaa aaa, and so on

Path/Array/String Conversion

Use the Path/Array/String Conversion functions to convert strings, arrays, and paths.

Palette Object Description


Path to Array of Strings Converts a path into an array of strings and indicates whether the path is
Function relative.
Array of Strings to Path
Converts an array of strings into a relative or absolute path.
Function
Converts path into a string describing a path in the standard format of
Path To String Function
the platform.
Converts a string, describing a path in the standard format for the
String To Path Function
current platform, to a path.
String To Byte Array
Converts a string into an array of unsigned bytes.
Function
Byte Array To String Converts an array of unsigned bytes representing ASCII characters into a

© National Instruments 663


Functions

Palette Object Description


Function string.

Path to Array of Strings Function

Converts a path into an array of strings and indicates whether the path is relative.

Inputs/Outputs
• path —

path is the path you want to convert to an array of strings.

If path is <Not A Path>, the array of strings is empty and relative is FALSE.
• relative —

relative indicates whether the path you converted is a relative path or an absolute path.

If TRUE, it is a relative path. If FALSE, it is an absolute path.


• array of strings —

array of strings contains the components of the path.

The first element is the first step of the path hierarchy. For file systems that support multiple
volumes, the first element is the volume name. If path is a network path, the first element of
array of strings includes the name of the server in addition to the first step of the path hierarchy.
The last element of array of strings is the file or directory specified by the path.

Array of Strings to Path Function

Converts an array of strings into a relative or absolute path.

If you have an empty string in the array, the directory location before the empty string
is deleted in the path output. This behavior is similar to moving up a level in directory
hierarchy.

664 ni.com
Functions

Inputs/Outputs
• relative —

relative indicates whether you want to create a relative path or an absolute path.

If TRUE, the function creates a relative path. If FALSE (default), the function creates an absolute
path. If FALSE and the path specified is not valid as an absolute path (for example, the path
means go up a level), the function sets path to <Not A Path>.

• array of strings —

array of strings contains the names of the components of the path you want to build.

The first element is the highest level of the path hierarchy (the volume name, for file systems
that support multiple volumes), and the last element is the last element of the hierarchy. An
element that contains an empty string tells LabVIEW to go up a level in the hierarchy.

Note Each string in the array of strings must represent a single element of the
complete path. Partial paths, such as test\subtest, are not valid as array
elements because they might produce invalid paths on platforms that use different
directory separators.

• path —

path is the resulting path.

Suppose the path to the VI containing this function is c:\dir1\main.vi. To use this
function to build a relative path to another VI such as c:\dir1\dir2\called.vi,
wire TRUE to relative. In array of strings, enter dir2 as the first element and
called.vi as the second element. The function returns a relative path of dir2\
called.vi. You can use the Build Path function to append the relative path to the
output of the Current VI's Path function.

To build an absolute path to c:\dir1\dir2\called.vi, wire FALSE to relative. In


array of strings, enter c as the first element, dir1 as the second element, dir2 as

© National Instruments 665


Functions

the third element, and called.vi as the fourth element. The function returns an
absolute path of c:\dir1\dir2\called.vi.

Path To String Function

Converts path into a string describing a path in the standard format of the platform.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• path —

path is the path, array of paths, cluster of paths, or array of clusters of paths you want to convert
to a string.

If path is <Not A Path>, the function sets string to <Not A Path>.


• string —

string is the path descriptor(s) represented by path in the standard format for the current
platform. string is of the same data type structure as path.

String To Path Function

Converts a string, describing a path in the standard format for the current platform, to
a path.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string —

666 ni.com
Functions

string can be a string or any data structure that contains only strings, such as an array or clusters
of strings.

• path —

path is the platform-independent representation of the path described by string.

If string is not a valid path descriptor on the current platform, the function sets path to <Not a
Path>. path is of the same data type structure as string.

Note If string is <Not a Path>, the function returns a path to <Not a Path>. If
you attempt to use the path, LabVIEW cannot find the file and throws an error.

String To Byte Array Function

Converts a string into an array of unsigned bytes.

Each byte in the array has the ASCII value of the corresponding character in the string.

Inputs/Outputs
• string —

string is the input string the function converts.

• unsigned byte array —

unsigned byte array is the output array.

The first byte in the array has the ASCII value of the first character in string, the second byte has
the second value, and so on.

Byte Array To String Function

Converts an array of unsigned bytes representing ASCII characters into a string.

© National Instruments 667


Functions

Inputs/Outputs
• unsigned byte array —

unsigned byte array is the array of ASCII values you want to convert.

• string —

string is the result of interpreting each array element as an ASCII value and forming a string out
of the corresponding characters.

Refer to ASCII Codes for the numbers that correspond to each character.

Scan From String

Scans the input string and converts the string according to format string.

Use this function when you know the exact format of the input. The input can be
string, path, enumerated type, time stamp, or numeric data. Alternatively, you can use
the Scan From File function to scan text from a file. The connector pane displays the
default data types for this polymorphic function.

Inputs/Outputs
• format string —

format string specifies how to convert the input string into the output arguments.

The default is to scan the string according to the default format for the data types of the outputs.
Formatting a time stamp as anything other than time returns an error. Right-click the function

668 ni.com
Functions

and select Edit Scan String from the shortcut menu to create and edit the format string.

A space in format string matches any amount of white space, such as spaces, tabs, linefeeds,
and form feeds.

This input accepts a maximum of 255 characters.

• input string —

input string is the string, path, enumerated type, time stamp, or numeric data to scan.

• initial scan location —

initial scan location is the offset into the string where the scan begins.

The default is 0.
• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• default value 1 —

default 1..n specifies the type and default value for the output parameters.

If this function cannot scan the input value from format string, the function uses the default. If
you do not wire default 1 and you wire a constant to format string, the function uses format
string to determine the type of the output. Otherwise, the default data type is double-precision,
floating-point. The default value is 0 or an empty string, depending on the output data type. If
you wire an enumerated type to default 1, the function finds substrings matching the string
values in the enumerated type and returns the corresponding numeric value of the enumerated
type.

You can scan for Boolean values if you use a string or numeric format code. If the format code is
%s or unwired, the function reads Y, T, TRUE, ON, or YES and any lowercase versions of those
words as TRUE Boolean values. The function reads F, FALSE, OFF, or NO and any lowercase
versions of those words as FALSE Boolean values. If you specify a numeric format code, the
function reads any numeric value greater than 0.5 as TRUE and any numeric value less than or
equal to 0.5 as FALSE.

Note This function reads negative numbers as FALSE Boolean values because the
function converts the number to an unsigned 8-bit integer and any number less than
or equal to 0.5 becomes 0 during the conversion.

© National Instruments 669


Functions

• remaining string —

remaining string returns the portion of the string that remains after scanning all arguments.

• offset past scan —

offset past scan is the offset of input string after completing the scan.

• error out —

error out contains error information. This output provides standard error out functionality.

• output 1 —

output 1..n specifies the output parameters.

Each output can be a string, path, enumerated type, time stamp, Boolean, or any numeric data
type. If you scan a string that does not fit into the numeric data type you specify, this function
returns the largest number that fits into that data type. You cannot use arrays and clusters with
this function.

Increase the number of parameters by right-clicking the function and selecting Add
Parameter from the shortcut menu or by resizing the function.

Note If an error occurs, the source component of the error out cluster
contains a string of the form ''Scan From String (arg n),'' where
n is the first argument for which the error occurred.

If you set format string to return numeric values in the output parameters, LabVIEW
ignores white spaces in the input string.

If you wire a block diagram constant string to format string, LabVIEW uses format
string to determine the number of outputs and the data type of each output at
compile time. If the types you wire to the outputs do not match the types determined
by format string, you must change the output types before the VI can run.

If you do not directly wire a block diagram constant to format string, LabVIEW checks
for type mismatches at run time. If you want to scan values that have data types other
than double-precision, floating point, you must wire the data types to default 1..n.

670 ni.com
Functions

Note By default, this function is locale aware, which means that it uses the
system decimal separator configured in the regional settings of the operating
system. In some instances, such as using GPIB instruments on European
operating systems, you may need to override the system decimal separator
by using the localization code syntax elements.

Examples of Formatting Strings

Refer to the Format Specifier Syntax topic for more information about and examples of
formatting strings.

remaining
input string format string default(s) output(s)
string
— abc
abc, xyz — xyz
%3s, %s%f%2d 00
>12.3+56i 7200 0.00+00i 12.30+56.00i
— 72
Q+1.27E–3 tail Q%f t — 1.27E–3 ail
— 12.00
0123456789 %3d%3d 6789
— 345
100 (I32) 10
X:9.860 Z:3.450 X:%fY:%f Z: 3450
100.00 (DBL) 100.00
set49.4.2 set%d — 49 .4.2
blue (enum {red,
color: red color: %s red —
green, blue})
abcd
12
abcd012xyz3 %[a-z]%d%[a-z]%d — —
xyz
3
welcome to
welcome to
LabVIEW, John %[^,],%s — Smith
LabVIEW
Smith

© National Instruments 671


Functions

remaining
input string format string default(s) output(s)
string
John

11:15:04.250
Time: 23:15:04.25
Time: PM
1/1/1904 —
%<%H:%M:%S%2u%m/%d/%Y>T
5/31/2004
5/31/2004

Format Into String

Formats string, path, enumerated type, time stamp, Boolean, or numeric data as text.

You can use the Format Into String function to convert a number into a string. To
format data as text and write the text to a file, use the Format Into File function
instead.

Inputs/Outputs
• format string —

format string specifies how you want the function to convert the input arguments into resulting
string.

Defaults match the data type of the input arguments. Right-click the function and select Edit
Format String from the shortcut menu to create and edit the format string. Use special escape
codes to insert non-displayable characters, the backslash, and the percent characters.

Note This function interprets backslashes as escape characters. To use a literal


backslash in format string, you must enter \\.

• initial string —

672 ni.com
Functions

initial string specifies the base string to which you can append any arguments to form the
resulting string.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• input 1 —

input 1..n specifies the input parameters you want the function to convert.

This parameter accepts a string, path, enumerated type, time stamp, Boolean, or any numeric
data type. For complex numeric data types, this function converts only the real component. You
cannot use arrays and clusters with this function. You can specify up to 4,096 characters for each
input.

If you specify a Boolean value for this parameter and %s as the format code, the Format Into
String function outputs the value as TRUE or FALSE. If you specify a Boolean value for this
parameter and any numeric format code, the Format Into String function outputs the
appropriate version of 1 for TRUE and 0 for FALSE. For example, if you specify %f as the format
code, the function outputs 1.00000. If you specify %d, the function outputs 1.

• resulting string —

resulting string contains the concatenation of initial string and the formatted output.

• error out —

error out contains error information. This output provides standard error out functionality.

To increase the number of parameters, right-click input 1 and select Add Parameter
from the shortcut menu or resize the function.

Note If an error occurs, the error out cluster element source contains a
string of the form Format Into String (arg n), where n is the first
argument for which the error occurred.

If you wire a block diagram constant string to format string, LabVIEW uses format
string to determine the number of outputs and the data type of each output at

© National Instruments 673


Functions

compile time. If the data types you wire to the outputs do not match the data types
determined by format string, you must change the output data types before the VI can
run.

Specifying Which Input to Use within the Format String

By default, this function uses the order of the inputs to populate the format specifiers,
or percent codes in the Format String. However, you can use a number followed by a
dollar sign ($) within a percent code to specify exactly which input to use for that
percent code. For example, the percent code %3$d uses the third input regardless of
how many percent codes appear before %3$d in the format string.

Refer to the following block diagram and table for an example of how to use format
specifiers:

The following input combinations illustrate the effects of the $ specifier in the previous
block diagram:

Input Format Return


Input 2 Comments
1 String String

first Format String does not use the $ specifier, so the


first second %s %s
second function populates the percent codes in input order.
%2$s second Format String uses the $ specifier to display the
first second
%1$s first inputs in a different order than their input order.
%1$s first
Format String uses the $ specifier to display the first
first second %1$s first
input multiple times and ignore the second input.
%1$s first

You can use other special characters besides the $ to configure how this function
populates the percent codes in format string.

674 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Spreadsheet\Tab-Delimited Data\


Buffered Stream to Tab-Delimited Text File.vi

Format Date/Time String Function

Displays a timestamp value or a numeric value as time in the format you specify using
time format codes.

Inputs/Outputs
• time format string (%c) —

time format string specifies the format of the output string.

Time format codes (beginning with %) not recognized by the function as a format code return the
character literally. The default code is %c, which corresponds to the date/time representation
appropriate for the configured time zone for the computer. If time format string is an empty
string, the function uses the default.
• time stamp —

time stamp can be a timestamp or a numeric. If numeric, this number is the time-zone-
independent number of seconds that have elapsed since 12:00 a.m., Friday, January 1, 1904,
Universal Time [01-01-1904 00:00:00]. The default is the current date and time.

If year is before 1904, time stamp is negative.


• UTC format —

UTC format specifies if the output string is in Universal Time or in the configured time zone for
the computer. If TRUE, date/time string is in Universal Time.

The default is FALSE.


• date/time string —

© National Instruments 675


Functions

date/time string is the formatted date/time string.

This function calculates date/time string by copying time format string and replacing
each of the time format codes with the corresponding values. For example, the time
format string %y%m%d displays timestamp in the format yymmdd. The time format
string %y%m%d displays the date January 30, 2014 as 140130.

The following list describes some of the caveats to consider when you use this
function:

• LabVIEW returns abbreviated weekday and month names as numeric values for
systems that do not support abbreviated names, such as Chinese and Korean.
• The %c, %u, %x, %X, %z, and %Z format codes depend on operating system locale
support. The output of these codes is platform dependent. Interpretation of the
Daylight Saving Time rule also can vary by platform.
• The %p format code only takes effect at locales that use the 12-hour time system.
• Time format codes have leading zeros as necessary to ensure a constant field
width. An optional # modifier before the format code letter removes the leading
zeros from the following format codes: %#d, %#H, %#I, %#j, %#m, %#M,
%#s, %#S, %#U, %#w, %#W, %#X, %#y, %#Y. The # modifier does not
modify the behavior of any other format codes.

Related Information

Time Format Codes

Build Text

Creates an output string from a combination of text and parameterized inputs. If the
input is not a string, this Express VI converts the input into a string based on the
configuration of the Express VI.

676 ni.com
Functions

Dialog Box Options

Option Description

Specifies the text you want to build. Define parameters by placing text between
Text with
a pair of percent signs. You can use each parameter only once in the text that
Parameters in
you build.
Percents
(%parameter
To include a percent sign in the output string, you must type the percent sign
name%)
twice.

Contains the following options:

• Parameter—

Lists all parameters defined in the Text with Parameters in Percents


(%parameter name%) section.

• Sample text—

Displays text configured according to the options set in Parameter


Properties.

• Sample boolean—
Configure
Parameters Displays a button configured according to the options set in Parameter
Properties.

• Sample number—

Displays a number configured according to the options set in Parameter


Properties.

• Sample result—

Displays the value you enter in Sample text, Sample number, or Sample
boolean based on the options you select in the Parameter Properties
section.

Contains the following options:


Parameter
Properties • Text—

© National Instruments 677


Functions

Option Description

Formats the parameter as a text string.

• Number—

Formats the parameter as a numeric value.

• Boolean—

Formats the parameter as a Boolean value.

• Format—

Provides formatting options for the parameter depending on the data type.
Examples of each format appear in parentheses after the name of the
format.

• Use minimum field width—

Pads any excess space to the left or right of the text, number, or Boolean
with zeros or spaces to reach the minimum width you enter in Minimum
field width.

• Minimum field width—

Specifies the width to which you want to pad the text, number, or Boolean.
The default is 0.

• Use specified precision—

Formats the numbers with the precision you specify in Precision. This
option is available only when you select Fractional/Scientific (12.345),
Fractional (12.345), or Scientific (1.234E1) from the Format the numbers
pull-down menu.

• Precision—

Changes the digits of precision of the numbers in the table. The default is
0.

Justification Contains the following options:

678 ni.com
Functions

Option Description

• Left—

Justifies the parameter to the left.

• Right—

Justifies the parameter to the right.

Contains the following options:

• Using spaces—

Pads numbers using spaces.


Padding
• Using zeros—

Pads numbers using zeros.

Inputs/Outputs
• Beginning Text —

Prepends the text you wire to this input to the text the Express VI generates.

• error in (no error) —

Describes error conditions that occur before this node runs.

• error out —

Contains error information. This output provides standard error out functionality.

• Result —

Returns the resulting data based on the configuration of the Express VI.

Components

Changes the digits of precision of the numbers in the table. The default is 0.

© National Instruments 679


Functions

Formats the numbers with the precision you specify in Precision. This option is
available only when you select Fractional/Scientific (12.345), Fractional (12.345), or
Scientific (1.234E1) from the Format the numbers pull-down menu.

Pads any excess space to the left or right of the text, number, or Boolean with zeros or
spaces to reach the minimum width you enter in Minimum field width.

Pads numbers using zeros.

Justifies the parameter to the left.

Provides formatting options for the parameter depending on the data type. Examples
of each format appear in parentheses after the name of the format.

Displays a button configured according to the options set in Parameter Properties.

Formats the parameter as a Boolean value.

Displays a number configured according to the options set in Parameter Properties.

Formats the parameter as a numeric value.

Displays text configured according to the options set in Parameter Properties.

Formats the parameter as a text string.

Changes the digits of precision of the numbers in the table. The default is 0.

Specifies the width to which you want to pad the text, number, or Boolean. The default
is 0.

Formats the numbers with the precision you specify in Precision. This option is
available only when you select Fractional/Scientific (12.345), Fractional (12.345), or
Scientific (1.234E1) from the Format the numbers pull-down menu.

Pads any excess space to the left or right of the text, number, or Boolean with zeros or
spaces to reach the minimum width you enter in Minimum field width.

Pads numbers using spaces.

680 ni.com
Functions

Pads numbers using zeros.

Justifies the parameter to the right.

Justifies the parameter to the left.

Provides formatting options for the parameter depending on the data type. Examples
of each format appear in parentheses after the name of the format.

Specifies the text you want to build. Define parameters by placing text between a pair
of percent signs. You can use each parameter only once in the text that you build.

Lists all parameters defined in the Text with Parameters in Percents (%parameter
name%) section.

Displays the value you enter in Sample text, Sample number, or Sample boolean
based on the options you select in the Parameter Properties section.

Number/String Conversion

Use the String/Number Conversion functions to convert strings.

Palette
Description
Object
Number To
Converts number to a string of decimal digits at least width characters wide or wider
Decimal
if necessary. If number is floating-point or fixed-point, it is rounded to a 64-bit
String
integer before conversion.
Function
Number To Converts number to a string of hexadecimal digits at least width characters wide or
Hexadecimal wider if necessary. The digits A-F always appear in uppercase in the output string. If
String number is floating-point or fixed-point, it is rounded to a 64-bit integer before
Function conversion.
Number To Converts number to a string of octal digits at least width characters wide or wider if
Octal String necessary. If number is floating-point or fixed-point, it is rounded to a 64-bit integer
Function before conversion.

© National Instruments 681


Functions

Palette
Description
Object
Number To
Fractional Converts number to an F-format (fractional notation), floating-point string at least
String width characters wide or wider if necessary.
Function
Number To
Exponential Converts number to an E-format (exponential notation), floating-point string at least
String width characters wide or wider if necessary.
Function
Number To
Engineering Converts number to an engineering format, floating-point string at least width
String characters wide or wider if necessary.
Function
Format
Converts a number into a regular string according to the format specified in format
Value
string and appends this to string.
Function
Decimal
String To Converts the numeric characters in string, starting at offset, to a decimal integer and
Number returns it in number.
Function
Hexadecimal
String To Interprets the characters 0 through 9, A through F, and a through f in string starting
Number at offset as a hex integer and returns it in number.
Function
Octal String Interprets the characters 0 through 7 in string starting at offset as an octal integer
To Number and returns it in number. This function also returns the index in string of the first
Function character following the number.
Fract/Exp
Interprets the characters 0 through 9, plus, minus, e, E, and the decimal point
String To
(usually period) in string starting at offset as a floating-point number in engineering
Number
notation, exponential, or fractional format and returns it in number.
Function
Converts characters at the beginning of string to the data type represented by
Scan Value default, according to the conversion codes in format string, and returns the
Function converted number in value and the remainder of string after the match in output
string.

682 ni.com
Functions

Number To Decimal String Function

Converts number to a string of decimal digits at least width characters wide or wider if
necessary. If number is floating-point or fixed-point, it is rounded to a 64-bit integer
before conversion.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• width (-) —

width must be numeric. If unwired, the function uses exactly as many digits as are needed to
represent the number, with no extra padding.

• decimal integer string —

decimal integer string is the resulting decimal string.

The following table shows how the values of number and width affect decimal integer string. In
this table, the underline character ( _ ) represents spaces in decimal integer string.

decimal integer
number width Comments
string
Floating-point and fixed-point numbers are rounded to
4.6 2 _5
integers.
3.0 4 _ _ _3 If width is larger than needed, spaces are added on the left.
If width is inadequate, decimal integer string is as large as
–311 3 –311
necessary.

© National Instruments 683


Functions

Number To Hexadecimal String Function

Converts number to a string of hexadecimal digits at least width characters wide or


wider if necessary. The digits A-F always appear in uppercase in the output string. If
number is floating-point or fixed-point, it is rounded to a 64-bit integer before
conversion.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• width (-) —

width must be numeric. If unwired, the function uses exactly as many digits as are needed to
represent the number, with no extra padding.

• hex integer string —

hex integer string is the resulting hexadecimal string.

The following table shows how the values of number and width affect hex integer string.

hex
number width integer Comments
string
3 4 0003 If width is larger than needed, zeros are added on the left.
42 3 02A —
–4.2 is rounded up to –4 in 64-bit integer format. Width is too small to
–4.2 3 FFFFFFFC represent the hex version of a negative number, so the field width is
extended.

684 ni.com
Functions

Number To Octal String Function

Converts number to a string of octal digits at least width characters wide or wider if
necessary. If number is floating-point or fixed-point, it is rounded to a 64-bit integer
before conversion.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• width (-) —

width must be numeric. If unwired, the function uses exactly as many digits as are needed to
represent the number, with no extra padding.

• octal integer string —

octal integer string is the resulting octal string. The following table shows how the values of
number and width affect octal integer string.

octal integer
number width Comments
string
3 4 0003 —
42 3 052 —
–4.2 is rounded up to –4 in 64-bit integer format. width is too small
–4.2 3 37777777774 to represent the octal version of a negative number, so the field
width is extended.

Number To Fractional String Function

Converts number to an F-format (fractional notation), floating-point string at least

© National Instruments 685


Functions

width characters wide or wider if necessary.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• use system decimal point (T) —

use system decimal point defines the decimal separator. If TRUE (default), the decimal
separator uses the localized decimal separator. If FALSE, the decimal separator is a period.

• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• width (-) —

width must be numeric. If unwired, the function uses exactly as many digits as are needed to
represent the number, with no extra padding.

• precision (6) —

precision must be numeric. The function rounds the number of digits after the decimal point of
the output string to precision.

• F-format string —

F-format string is the resulting fractional string. F-format string can be Inf, -Inf, or NaN if the
value you wire to number is infinity or is not a number. The following table shows how the
values of number, width, and precision affect F-format string. In this table, the underline
character ( _ ) represents a space in F-format string.

number width precision F-format string Comments


4.925 6 2 _ _4.92 number is rounded, padded with spaces on the left.
.003926 8 4 _ _0.0039 number is rounded, padded with spaces on the left.
–287.3 5 0 _–287 number is rounded, padded with spaces on the left.

686 ni.com
Functions

This function rounds number to the nearest integer. If the fractional part of number is
.5, the function rounds the value to the nearest even integer. For example, the
function rounds 13.5 to 14 and rounds 14.5 to 14.

Number To Exponential String Function

Converts number to an E-format (exponential notation), floating-point string at least


width characters wide or wider if necessary.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• use system decimal point (T) —

use system decimal point defines the decimal separator. If TRUE (default), the decimal
separator uses the localized decimal separator. If FALSE, the decimal separator is a period.

• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• width (-) —

width must be numeric. If unwired, the function uses exactly as many digits as are needed to
represent the number, with no extra padding.

• precision (6) —

precision must be numeric. The function rounds the number of digits after the decimal point of
the output string to precision.

• E-format string —

E-format string is the resulting string. The following table shows how the values of number,
width, and precision affect E-format string. In this table, the underline character ( _ ) represents

© National Instruments 687


Functions

a space in E-format string.

number width precision E-format string Comments


4.911 5 2 4.91e0 number is rounded, width is extended.
.003926 10 2 _ _ _3.93e–3 number is rounded, padded with spaces on the left.
216.01 5 0 _ _2e2 number is rounded, padded with spaces on the left.

Number To Engineering String Function

Converts number to an engineering format, floating-point string at least width


characters wide or wider if necessary.

Engineering format is similar to E format (exponential notation), except the exponent


is a multiple of three (..., –3, 0, 3, 6, ...). The connector pane displays the default data
types for this polymorphic function.

Inputs/Outputs
• use system decimal point (T) —

use system decimal point defines the decimal separator. If TRUE (default), the decimal
separator uses the localized decimal separator. If FALSE, the decimal separator is a period.

• number —

number can be a scalar number, array or cluster of numbers, array of clusters of numbers, and
so on.

• width (-) —

width must be numeric. If unwired, the function uses exactly as many digits as are needed to
represent the number, with no extra padding.

• precision (6) —

688 ni.com
Functions

precision must be numeric. The function rounds the number of digits after the decimal point of
the output string to precision.

• Engineering string —

Engineering string is the resulting string.

The following table shows how the values of number, width, and precision affect Engineering
string. In this table, the underline character ( _ ) represents a space in Engineering string.

number width precision Engineering string Comments


4.93 10 2 _ _ _4.93E+0 number is rounded, padded with spaces on the left.
.49 10 2 _490.00E-3 number is rounded, padded with a space on the left.
61.96 8 1 _62.0E+0 number is rounded, padded with a space on the left.
1789.32 8 2 _ 1.79E+3 number is rounded, padded with a space on the left.

Format Value Function

Converts a number into a regular string according to the format specified in format
string and appends this to string.

The connector pane displays the default data types for this polymorphic function.

Note The Format Into String function has the same functionality as Format
Value but can use multiple inputs. Consider using Format Into String instead
of this function to simplify your block diagram.

Inputs/Outputs
• string ("") —

string is the input string to which LabVIEW appends the formatted string. The default is an
empty string.

© National Instruments 689


Functions

• format string —

format string specifies how to convert value into output string.

Use the format string syntax.


• value (0) —

value must be numeric but can be a physical quantity. A physical quantity is a value with a unit.

• output string —

output string is the result of converting value to a string, and appending this to string.

Decimal String To Number Function

Converts the numeric characters in string, starting at offset, to a decimal integer and
returns it in number.

The connector pane displays the default data types for this polymorphic function.

If you want the function to return a 64-bit integer output, you must wire a 64-bit
integer to the default input.

Inputs/Outputs
• string —

string can be a string, a cluster of strings, an array of strings, or an array of clusters of strings.

• offset —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric.

The offset of the first character in string is 0. If offset is unwired or less than 0, the function takes
offset as 0.

690 ni.com
Functions

• default (0 I32) —

default is any object of numeric representation and specifies the numeric representation for
number. The default is a 32-bit signed integer value of 0.

• offset past number —

offset past number is the index in string of the first character following the number. offset past
number reflects the value from the last string if you input an array of strings.

• number —

number can be a number, a cluster, or an array of numbers, depending on the structure of


string.

If number is an integer, it can overflow if the input is out of range. In that case, number is set to
the maximum or minimum value for the data type. For example, if the input string is 300, and the
data type is a 8-bit signed integer, LabVIEW sets the value to 127. The following table shows how
the values of string, offset, and default affect number.

offset past
string offset default number Comments
number
13ax 0 0 2 13 —
–4.8bcde Because an integer is being converted,
0 0 2 –4
conversion conversion stops at the decimal point.
a49b 0 –9 0 –9 default is used since no digits were read.

Hexadecimal String To Number Function

Interprets the characters 0 through 9, A through F, and a through f in string starting at


offset as a hex integer and returns it in number.

The connector pane displays the default data types for this polymorphic function.

© National Instruments 691


Functions

Inputs/Outputs
• string —

string can be a string, a cluster of strings, an array of strings, or an array of clusters of strings.

• offset —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric.

The offset of the first character in string is 0. If offset is unwired or less than 0, the function takes
offset as 0.

• default (0 U32) —

default is any object of numeric representation and specifies the numeric representation for
number. The default is a 32-bit unsigned integer value of 0. To return a 64-bit integer output,
wire a 64-bit integer to default.

• offset past number —

offset past number is the index in string of the first character following the number.

offset past number reflects the value from the last string if you input an array of strings.

• number —

number can be a number, a cluster, an array of numbers, or an array of clusters depending on


the structure of string and offset.

If the input string represents a number outside the range of the representation of number,
number is set to the maximum value for that data type.

The following table illustrates how string, offset, and default affect number.

offset
string offset default past number Comments
number
The conversion starts from the first character
3ab 0 3 939
3, as offset specifies.

692 ni.com
Functions

offset
string offset default past number Comments
number
The conversion starts from the third character
3ab 2 3 11
b, as offset specifies.
number is a 32-bit unsigned integer, as default
specifies. The result of the conversion is
1FFFFFFFF 0 9 4294967295
saturated because it is too large to be
represented.
number is a 64-bit unsigned integer, as default
1FFFFFFFF 0 9 8589934591
specifies.
g is not a valid hex character, so conversion
stops there. The value of offset past number
f3g 0 2 243
indicates the conversion stops at the third
character g.
–30 0 0 0 Negative numbers are not permitted for hex.

Octal String To Number Function

Interprets the characters 0 through 7 in string starting at offset as an octal integer and
returns it in number. This function also returns the index in string of the first character
following the number.

The connector pane displays the default data types for this polymorphic function.

If you want the function to return a 64-bit integer output, you must wire a 64-bit
integer to the default input.

Inputs/Outputs
• string —

string can be a string, a cluster of strings, an array of strings, or an array of clusters of strings.

© National Instruments 693


Functions

• offset —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric.

The offset of the first character in string is 0. If offset is unwired or less than 0, the function takes
offset as 0.
• default (0 U32) —

default is any object of numeric representation and specifies the numeric representation for
number. The default is a 32-bit unsigned integer value of 0. To return a 64-bit integer output,
wire a 64-bit integer to default.

• offset past number —

offset past number is the index in string of the first character following the number.

offset past number reflects the value from the last string if you input an array of strings.
• number —

number can be a number, a cluster, an array of numbers, or an array of clusters, depending on


the structure of string.

If the input string represents a number outside the range of the representation of number,
number is set to the maximum value for that data type. The following table shows how the
values of string, offset, and default affect number.

string offset default offset past number number Comments


92 0 0 0 0 9 is not an octal digit.
071a 0 0 3 57 a is not an octal digit, so conversion stops there.

Fract/Exp String To Number Function

Interprets the characters 0 through 9, plus, minus, e, E, and the decimal point (usually
period) in string starting at offset as a floating-point number in engineering notation,
exponential, or fractional format and returns it in number.

The connector pane displays the default data types for this polymorphic function.

694 ni.com
Functions

Inputs/Outputs
• use system decimal point (T) —

use system decimal point defines the decimal separator.

If TRUE (default), the decimal separator uses the localized decimal separator. If FALSE, the
decimal separator is a period.
• string —

string can be a string, a cluster of strings, an array of strings, or an array of clusters of strings.

If string contains the characters Inf or NaN, this function returns the LabVIEW values Inf and
NaN, respectively.
• offset —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric.

The offset of the first character in string is 0. If offset is unwired or less than 0, the function takes
offset as 0.
• default (0 DBL) —

default is any object of numeric representation and specifies the numeric representation for
number.

The default is a double-precision, floating-point value of 0.


• offset past number —

offset past number is the index in string of the first character following the number.

offset past number reflects the value from the last string if you input an array of strings.
• number —

number can be a number, a cluster, an array of numbers, or an array of clusters, depending on


the structure of string.

The following table shows how the values of string, offset, and default affect number.

© National Instruments 695


Functions

offset past
string offset default number Comments
number
–4.7e–3x 0 0 7 –0.0047 x is not allowed, so conversion stops there.
Second decimal point not allowed, so conversion
+5.3.2 0 0 4 5.3
stops there.

If you scan a string that does not fit into the numeric data type you specify, this function returns
the largest number that fits into that data type.

If you want the function to return a 64-bit integer output, you must wire a 64-bit
integer to the default input.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Strings\Extract Numbers with Match


Pattern.vi

Scan Value Function

Converts characters at the beginning of string to the data type represented by default,
according to the conversion codes in format string, and returns the converted number
in value and the remainder of string after the match in output string.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string —

string is the input string the function scans.

• format string —

696 ni.com
Functions

format string specifies how to convert the input arguments into value.

Use the format string syntax.


• default (0 dbl) —

default is the numeric representation for value.

The default is a double-precision, floating-point value of 0.


• output string —

output string is the remaining characters in string after the match or string if there is no match.

• value —

value is the converted value or the value in default if there is no match.

If value is an integer, it can overflow if the input is out of range. In that case, value is set to the
maximum or minimum value for the data type. For example, if the input string is 300 and the
data type is an 8-bit signed integer, LabVIEW sets the value to 127.

Spreadsheet String To Array Function

Converts the spreadsheet string to an array of the dimension and representation of


array type. This function works for arrays of strings and arrays of numbers.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• delimiter (Tab) —

delimiter specifies the value or values used to separate fields in the spreadsheet file. The default
is a single tab character. You can specify multiple delimiters by wiring an array of strings to
delimiter. Each element of the array should contain a different delimiter.

For example, if you wire an array that contains two elements — a space character in one and a
tab character in the other — the function allows either a space character or a tab character to

© National Instruments 697


Functions

separate elements in the output array.


• format string —

format string specifies how to convert the spreadsheet string into an array. Use %s to convert
spreadsheet string to an array of strings. Use %d or %f to convert spreadsheet string to an array
of numbers.

Use the format string syntax.


• spreadsheet string —

spreadsheet string contains numeric or string values separated into columns by delimiters, such
as tabs or commas, with an end-of-line (EOL) character separating rows.

The function converts each element in spreadsheet string according to format string and stores
the resulting values in array.
• array type (2D Dbl) —

array type is the data type input for the array. The default is a 2D array of double-precision,
floating-point numbers.

Refer to Array To Spreadsheet String for information about the spreadsheet format expected for
arrays of three dimensions or more.
• array —

array is spreadsheet string converted to an array of the dimension and representation of array
type.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Spreadsheet\Tab-Delimited Data\


Tab-Delimited Data.lvproj

Array To Spreadsheet String Function

Converts an array of any dimension to a table in string form, containing tabs


separating column elements, a platform-dependent EOL character separating rows,
and, for arrays of three or more dimensions, headers separating pages.

698 ni.com
Functions

Inputs/Outputs
• delimiter (Tab) —

delimiter is the value used to separate fields in the spreadsheet file. The default is a single tab
character.

• format string —

format string specifies how to convert the input array into a string. Use %s to convert an array of
strings to spreadsheet string. Use %d or %f to convert arrays of numbers to spreadsheet string.

Use the format string syntax.

Note This function allows you to use only a single format specifier to format all
elements of an array. You cannot wire multiple specifiers to this function to format
some array elements according to one specifier and some elements to a different
specifier.

• array —

array specifies the input samples.

• spreadsheet string —

spreadsheet string is separated into columns by delimiters, such as tabs, and an end-of-line
(EOL) character separates rows.

For arrays of three dimensions or more, each page is preceded by a series of indexes of
the following format.

[n,m,…,0,0]

where n is the highest dimension index, m is the next highest dimension index, a
comma (,) separates indexes, 0,0 refers to the first row and column elements of page
n,m,…, and represents the end-of-line character.

© National Instruments 699


Functions

In the following example, a spreadsheet string of a 4x4x3 array appears as it does when
you print it. The period character (.) represents omitted values of the latter pages, and
the end-of-line character ( ) does not appear in an actual printout.

[0,0,0]

1.3 2.6 5.7

3.9 –4.2 6.5

–5.5 9.3 3.3

9.6 9.8 0.4

[1,0,0]

. . .

. . .

. . .

. . .

[2,0,0]

. . .

700 ni.com
Functions

. . .

. . .

. . .

[3,0,0]

. . .

. . .

. . .

. . .

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Array to Spreadsheet String.vi

To Upper Case Function

Converts all alphabetic characters in string to uppercase characters. Evaluates all


numbers in string as ASCII codes for characters. This function does not affect non-
alphabetic characters.

© National Instruments 701


Functions

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string —

string can be a string, a cluster of strings, an array of strings, or an array of clusters of strings.

• all upper case string —

all upper case string has the same structure as string.

If string is a numeric value or an array of numeric values, each number is evaluated as


an ASCII value. The To Upper Case function translates all values in the range of 97 to
122 into values over the range of 65 to 90. It also translates any other value in the
extended ASCII character set that has an uppercase counterpart, such as lowercase
alphabetic characters with accents.

To Lower Case Function

Converts all alphabetic characters in string to lowercase characters. Evaluates all


numbers in string as ASCII codes for characters. This function does not affect non-
alphabetic characters.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string —

string can be a string, a cluster of strings, an array of strings, or an array of clusters of strings.

• all lower case string —

702 ni.com
Functions

all lower case string has the same structure as string.

If string is a numeric value or an array of numeric values, each number is evaluated as


an ASCII value. The To Lower Case function translates all values in the range of 65 to 90
into values over the range of 97 to 122. It also translates any other value in the
extended ASCII character set that has a lowercase counterpart, such as uppercase
alphabetic characters with accents.

Flatten/Unflatten String

Use the Flatten/Unflatten String functions to flatten and unflatten LabVIEW data types
to and from strings.

Palette
Description
Object
Flatten To Converts the anything input to a flattened data string of binary values. You also can
String use this function to convert the byte order, or endian format, of the data in the
Function flattened data string.
Unflatten Converts binary string to the type wired to type. binary string should contain
From String flattened data of the type wired to type. You also can use this function to specify the
Function byte order, or endian format, of the data in the binary string.
Variant To
Flattened Converts variant data into a flattened string and an array of integers that represent
String the data type. You cannot flatten ActiveX variant data.
Function
Flattened
String To
Converts flattened data into variant data.
Variant
Function
Flatten To
Converts any data type you wire to anything and converts it to an XML string
XML
according to the LabVIEW XML schema.
Function

© National Instruments 703


Functions

Palette
Description
Object
Unflatten
Converts an XML string to a LabVIEW data type according to the LabVIEW XML
From XML
schema.
Function
Flatten To
Converts data you wire to the anything input to a UTF-8 JavaScript Object Notation
JSON
(JSON) string.
Function
Unflatten
Converts a UTF-8 JavaScript Object Notation (JSON) string to the LabVIEW data type
From JSON
you wire to type/defaults.
Function

Flatten To String Function

Converts the anything input to a flattened data string of binary values. You also can
use this function to convert the byte order, or endian format, of the data in the
flattened data string.

Inputs/Outputs
• anything —

anything contains the data you want to convert to a UTF-8 JSON string. This input accepts arrays
and clusters of Booleans, floating-point numbers, and strings. anything can also accept an array
of clusters, or a cluster of arrays, of these data types. This input does not support other data
types, such as enums, refnums, file paths, and fixed-point numbers.

Cluster elements may be named or unnamed, but not a combination of both. If cluster elements
are named, then each name must be unique to that cluster. If you wire an unsupported data
type, LabVIEW breaks the VI.

• prepend array or string size? (T) —

prepend array or string size? specifies whether LabVIEW includes data size information at the

704 ni.com
Functions

beginning of data string when anything is an array or string. If prepend array or string size? is
FALSE, LabVIEW does not include the size information. The default is TRUE.

The string created by the Flatten To String function is a LabVIEW string. If prepend array or
string size? is TRUE, the LabVIEW string has a 4-byte (I32) number at the beginning of the string
that tells how long the string is. This enables a LabVIEW string to include NULL characters [ASCII
character zero (0)]. If you pass a LabVIEW string to external code and use it as a C string, NULL
characters embedded in the string may cause problems, since C strings are interpreted as
terminating at the first NULL character. prepend array or string size? only controls the top-level
data size information. Arrays and strings in hierarchical data types such as clusters always
include size information.

• byte order (0:big-endian, network order) —

byte order sets the endian format of the data in the resulting flattened string. Byte order, or
endian form, indicates whether integers are represented in memory from most significant byte
to least significant byte or vice versa.

big-endian, network order (default)—The most significant byte occupies the lowest memory
0
address.
1 native, host order—Uses the byte-ordering format of the host computer.
2 little-endian—The least significant byte occupies the lowest memory address.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• data string —

data string is the flattened data generated by the function.

data string might contain header information before each non-scalar component describing its
size. Such a string can be stored in a file or sent over a network. If you send the string over a
network, the receiver must be able to interpret it. Usually, LabVIEW stores data as
noncontiguous, indirectly referenced pieces. This function copies the data in LabVIEW form into
a contiguous buffer data string. Use the Unflatten From String function to convert a data string
back to any data type.

• type string (7.x only) —

type string (7.x only) is visible only if the terminal is already wired from a previous version of

© National Instruments 705


Functions

LabVIEW or if you right-click the function and select Convert 7.x Data from the shortcut menu.
type string (7.x only) is an encoded binary description of data string. type string (7.x only) is
not the same as the type input in the Unflatten From String function.

If type string (7.x only) cannot represent the data type wired to anything, this function returns
an error.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Type Cast function for conversion of data types that does not result in
flattened data.

If you need to flatten type descriptor data to a string that is readable by LabVIEW 7.x or
earlier, right-click this function and select Convert 7.x Data from the shortcut menu. In
Convert 7.x Data mode, this function shows the type string (7.x only) output and
displays the icon for this function with a red 7.x on it. LabVIEW 7.x and earlier stores
type descriptors in 16-bit flat representation. LabVIEW 8.0 and later stores type
descriptors in 32-bit flat representation. National Instruments recommends reworking
any application that uses the Convert 7.x Data mode as a long term solution.

If you need to flatten Boolean data to a string that is readable by LabVIEW 4.x or
earlier, right-click this function and select Convert 4.x Data from the shortcut menu.
The Convert 4.x Data shortcut menu item is visible only if you wire Boolean data to
anything. In Convert 4.x Data mode, this function writes the data in LabVIEW 4.x data
storage layout and displays the icon for this function with a red 4.x on it. LabVIEW 4.x
and earlier stores Boolean data in two bytes unless the data is in an array, in which
case LabVIEW stores each Boolean element in a single bit. LabVIEW 5.0 and later stores
Boolean values in a single byte, regardless of whether it is in an array. National
Instruments recommends reworking any application that uses the Convert 4.x Data
mode as a long term solution.

If you use this function to flatten variant data, LabVIEW flattens the variant and all its
contents, including attributes. However, if you use the Variant To Flattened String
function, LabVIEW flattens only the variant and discards any attributes.

706 ni.com
Functions

If you use this function to flatten data from a custom control or indicator that you
saved as a type definition, the function strips the type definition of its type definition
wrapper. If you do not want to strip this wrapper, right-click the function and select
Expose Typedefs from the shortcut menu. The Expose Typedefs shortcut menu item is
visible only if you wire data to type string (7.x only).

Unflatten From String Function

Converts binary string to the type wired to type. binary string should contain
flattened data of the type wired to type. You also can use this function to specify the
byte order, or endian format, of the data in the binary string.

Inputs/Outputs
• type —

type is a normally constructed LabVIEW type.

type is not the type string output in the Flatten To String function.

• binary string —

binary string is a flattened string that is typically generated by the Flatten To String function.

If data includes array or string size? is TRUE, binary string contains header information
describing its size.

• data includes array or string size? (T) —

data includes array or string size? indicates whether LabVIEW reads data size information from
the beginning of an incoming array or string. If data includes array or string size? is TRUE,
LabVIEW reads the size information from the beginning of binary string. If data includes array or
string size? is FALSE, LabVIEW detects the size information from the memory size of binary
string.

© National Instruments 707


Functions

The default is TRUE. data includes array or string size? only accesses the top-level data size
information. Arrays and strings in hierarchical data types such as clusters always include size
information.

• byte order (0:big-endian, network order) —

byte order indicates the endian format of the data in the incoming flattened string. Byte order,
or endian form, indicates whether integers are represented in memory from most-significant
byte to least-significant byte or vice versa.

big-endian, network order (default)—The most-significant byte occupies the lowest memory
0
address.
1 native, host order—Uses the byte-ordering format of the host computer.
2 little-endian—The least-significant byte occupies the lowest memory address.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• rest of the binary string —

rest of the binary string contains any leftover bytes that this function did not convert. This
function does not convert all the bytes if the size of binary string is not a multiple of the size of
type.

• value —

value returns binary string as unflattened data of the same data type and structure as type.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Type Cast function for conversion of data types that does not require already-
flattened data.

If you need to unflatten data from a string created by LabVIEW 4.x or earlier, right-click
this function and select Convert 4.x Data from the shortcut menu. In Convert 4.x Data
mode, this function interprets the data in LabVIEW 4.x data storage layout and displays

708 ni.com
Functions

the icon for this function with a red 4.x on it. LabVIEW 4.x and earlier stores Boolean
data in two bytes unless the data is in an array, in which case LabVIEW stores each
Boolean element in a single bit. LabVIEW 5.0 and later stores Boolean values in a single
byte, regardless of whether it is in an array. National Instruments recommends
reworking any application that uses the Convert 4.x Data mode as a long term
solution.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Binary\Endian Considerations\


Endian Considerations with Binary Files.vi
• labview\examples\Strings\Unflatten from String with
Little-Endian Data.vi

Variant To Flattened String Function

Converts variant data into a flattened string and an array of integers that represent the
data type. You cannot flatten ActiveX variant data.

Inputs/Outputs
• variant —

variant is the variant data you want converted to a string of flattened data.

• type string —

type string is an array of numeric integers that identifies the data type of the flattened string.

• data string —

data string is the resulting flattened data you converted from variant data.

© National Instruments 709


Functions

If you use this function to flatten variant data, LabVIEW flattens only the variant and
discards all its contents, including attributes. However, if you use the Flatten To String
function, LabVIEW flattens the variant and all of its attributes.

Flattened String To Variant Function

Converts flattened data into variant data.

Use the Flatten to String function to produce data string and type string.

Inputs/Outputs
• type string —

type string is an array of numeric integers that identifies the data type of the flattened string if
the data type existed in LabVIEW 7.x or earlier.

• data string —

data string is the flattened data you want to convert to variant data.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• variant —

variant is the resulting variant data.

• error out —

error out contains error information. This output provides standard error out functionality.

Flatten To XML Function

Converts any data type you wire to anything and converts it to an XML string according

710 ni.com
Functions

to the LabVIEW XML schema.

If anything contains the characters <, >, or &, the function converts those characters to
&lt;, &gt;, or &amp;, respectively. Use the Escape XML VI to convert other
characters, such as ", to XML syntax.

Inputs/Outputs
• anything —

anything is any LabVIEW data you want to convert. This parameter is polymorphic.

• xml string —

xml string is the resulting XML string that represents the LabVIEW data type.

When converting decimal values, this function uses only the period (.) as a decimal separator.
The function does not use localized decimal separators.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\XML\Flatten and Unflatten XML\


Flatten and Unflatten XML.lvproj

Unflatten From XML Function

Converts an XML string to a LabVIEW data type according to the LabVIEW XML schema.

If xml string contains the characters &lt;, &gt;, or &amp;, the function converts
those characters to <, >, or &, respectively. Use the Unescape XML VI to convert other
characters, such as ".

© National Instruments 711


Functions

Inputs/Outputs
• xml string —

xml string is the XML string that includes the data you want to convert.

xml string must conform to the LabVIEW XML schema, including the case and order of tags in the
schema. If xml string does not conform to the schema, the function returns an error and value
contains the default value for the data type wired to type. If the VI containing the function
previously completed execution, value contains the value from the previous execution.

In xml string, this function accepts only the period (.) as a decimal separator. The function does
not recognize localized decimal separators. This restriction prevents errors when you use XML
strings on operating systems with different settings for the decimal separator.

• type —

type is the data type to which you want to convert xml string.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• value —

value is the data type you specified in type and the data in xml string.

• error out —

error out contains error information. This output provides standard error out functionality.

Flatten To JSON Function

Converts data you wire to the anything input to a UTF-8 JavaScript Object Notation
(JSON) string.

712 ni.com
Functions

Inputs/Outputs
• enable LabVIEW extensions? (T) —

enable LabVIEW extensions enables LabVIEW JSON extensions to support NaN and Inf values
of floating-point numbers. Not all JSON parsers support these extensions.

• anything —

anything contains the data you want to convert to a UTF-8 JSON string. This input accepts arrays
and clusters of Booleans, floating-point numbers, and strings. anything can also accept an array
of clusters, or a cluster of arrays, of these data types. This input does not support other data
types, such as enums, refnums, file paths, and fixed-point numbers.

Cluster elements may be named or unnamed, but not a combination of both. If cluster elements
are named, then each name must be unique to that cluster. If you wire an unsupported data
type, LabVIEW breaks the VI.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• JSON string —

JSON string is the flattened data encoded in UTF-8. UTF-8 encoded strings may not display
correctly in LabVIEW controls.

• error out —

error out contains error information. This output provides standard error out functionality.

Unflatten From JSON Function

Converts a UTF-8 JavaScript Object Notation (JSON) string to the LabVIEW data type
you wire to type/defaults.

© National Instruments 713


Functions

Inputs/Outputs
• enable LabVIEW extensions? (T) —

enable LabVIEW extensions enables LabVIEW JSON extensions to support NaN and Inf values
of floating-point numbers. Not all JSON parsers support these extensions.

• path —

path identifies a specific item in JSON string. Use path if your JSON string contains multiple
items, and you would like to extract a specific item from it. path uses an array of strings to
identify the item, where each element in the array references either the name of a cluster
element or an integer index of an array.

If you specify an item using path, you must wire a data type to type/defaults that corresponds to
the data type of the specified item.

For example, consider the JSON string {"0":"abc","1":false,"2":[9,8,7]}. The


following table illustrates the type/defaults inputs required for various paths and the resulting
value outputs.

path type/defaults value Comments


A cluster
If path is empty, type/defaults must account for each
containing string
element in the JSON string. For the example JSON
— abc, Boolean
string, you must wire a cluster containing a string, a
FALSE, and array
Boolean, and an array to type/defaults.
[9,8,7]
In this example, the path points to the cluster
String abc element named 0, or string abc. Therefore, you must
wire a string to type/defaults.
In this example, the path points to the cluster
element named 2, which is an array, and the element
DBL numeric 9 at index 0 of that array. This element is a floating-
point number, so a DBL numeric must be wired to
type/defaults.

• JSON string —

714 ni.com
Functions

JSON string is the flattened UTF-8 string that you want to unflatten. You can use the Flatten To
JSON function to generate this string.

• type and defaults —

type/defaults specifies the data type and default values to which you want to unflatten the
JSON string. This input accepts Booleans, integers, floating-point numbers, strings, and arrays
or clusters of these types. Cluster elements may be labeled or unlabeled, but not a combination
of both. If the elements in a cluster are labeled, then each name must be unique to that cluster. If
you wire an unsupported data type, LabVIEW breaks the VI.

If the elements in your JSON string are labeled, the elements wired to types/defaults must have
an identical label. For example, if you have JSON string
{"firstelement":"a","secondelement":"b"}, you must wire a cluster containing a
string labeled firstelement and a string labeled secondelement. Additionally, if you
specify the path to a particular item in your JSON string, the data type wired to type/defaults
must match the data type of the item pointed to by path.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• default null elements? (F) —

default null elements specifies whether LabVIEW uses default values from the input cluster for
null values in JSON. If default null elements is FALSE, LabVIEW returns an error for null values.

• strict validation? (F) —

strict validation determines whether LabVIEW returns an error when the JSON object contains
items not defined in the input cluster. If strict validation is FALSE, JSON objects may contain
items not defined in the cluster.

• value —

value returns JSON string as unflattened data of the same data type and structure as type/
defaults.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 715


Functions

If JSON string represents a data type that type/defaults does not accept, such as an
array of arrays or an array of mixed types, you cannot use a single Unflatten From
JSON function to convert the entire JSON string. However, you can use path to identify
and extract items in the JSON string.

String Constant

Use this constant to supply a constant text string to the block diagram.

Set the value of a string constant by using the Operating tool or the Labeling tool to
click it and enter the string you want. You also can set the value of a string constant by
right-clicking the constant and selecting Edit to display the Edit dialog box for string
constants.

Press the <Shift-Enter> keys on the keyboard to disable autosizing if it is enabled. If


autosizing is disabled, press the <Shift-Enter> keys on the keyboard to display a scroll
bar in the constant. If autosizing is disabled and the vertical scroll bar is not visible, the
constant resizes vertically as you enter text in the constant. Resizing a string constant
smaller than its contents displays the vertical scroll bar. If the vertical scroll bar is
visible and you resize the constant larger than its contents, LabVIEW hides the scroll
bar.

You can change the display mode so you can see non-displayable characters or the hex
ASCII equivalent to the characters. You also can set the constant in password display
mode so asterisks are displayed when you type in characters. Right-click a string
constant and select Visible Items»Display Style from the shortcut menu to display a
glyph on the constant that indicates the display type.

You cannot change the value of the string constant while the VI runs. You can assign a
label to this constant.

Empty String Constant

Consists of a constant string that is empty (length zero).

716 ni.com
Functions

Space Constant

Use this constant to supply a one-character space string to the block diagram.

Inputs/Outputs
• String —

Space constant string.

Tab Constant

Consists of a constant string containing the ASCII HT (horizontal tab) value.

Use this constant when you do not want to type in the backslash code for the
character.

Additional String Functions

Use the Additional String VIs and functions to scan and search in strings, match
patterns, and manipulate strings.

© National Instruments 717


Functions

Palette
Description
Object
Search/
Split
Divides a single string into two substrings.
String
Function
Pick Line
Chooses a line from multi-line string and appends that line to string.
Function
Match
Compares each prefix string in string array to the beginning of string until it encounters
First
a match. This function returns the original input string with the matching prefix string
String
removed.
Function
Match
True/ Examines the beginning of string to see whether it matches true string or false string.
False This function returns a Boolean TRUE or FALSE value in selection, depending on
String whether string matches true string or false string.
Function
Scan
String For Scans input string starting at offset for tokens and outputs each segment as a token
Tokens string.
Function

Searches string for substrings that match regular expression and replaces those
Search
substrings with replace string. A regular expression requires a specific combination of
and
characters for pattern matching. For more information about special characters in
Replace
regular expressions, refer to the regular expression input description in the detailed
Pattern
help.

Index
String
Selects a string specified by index from string array and appends that string to string.
Array
Function
Append
True/
Selects either a FALSE or TRUE string according to a Boolean selector and appends that
False
string to string.
String
Function
Rotate Places the first character of string in the last position of first char last, shifting the other

718 ni.com
Functions

Palette
Description
Object
String
characters forward one position. For example, the string abcd becomes bcda.
Function
Reverse
String Produces a string whose characters are in reverse order of those in string.
Function
Delimited
String to Converts substrings in a delimited string to the elements of a one-dimensional string
1D String array.
Array
1D String
Array to Converts the elements of a one-dimensional string array to a single string with input
Delimited array elements separated by a delimiting character.
String

Create NI
Generates a globally unique identifier (GUID) string.
GUID

Search/Split String Function

Divides a single string into two substrings.

You can divide the string at a certain character or substring. Search/Split String
searches string for the string or character in search string/char. The function splits the
string and returns the resulting two strings in substring before match and match +
rest of string.

Inputs/Outputs
• string —

string is the input string the function searches or splits.

© National Instruments 719


Functions

• search string/char (-) —

search string/char is the string or character to search for in string. If you do not wire this input or
it contains an empty string, the function splits string at offset. You must wire either search char
or offset.

• offset (0) —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric. The offset of the first character in string is 0. If offset is unwired
or less than 0, the function takes offset as 0.

• substring before match —

substring before match returns the portion of string before search string/char or before offset if
search string/char is unwired. If this function does not find the search string, substring before
match returns the entire original string.

• match + rest of string —

match + rest of string consists of search string/char and all subsequent characters in string. If
this function does not find the search string, match + rest of string returns an empty string.

• offset of match —

offset of match is the position of search string/char in string. If this function does not find the
search string, offset of match returns -1.

If you enable the Match Single Character option, this function uses only the first
character in search string/char and searches string for this character. When finding
the first match in string, this function splits string and returns the resulting two
strings. To enable the Match Single Character option, right-click this function and
select Match Single Character from the shortcut menu.

For example, when you specify Test string for string and str for search string/
char, this function returns different resulting strings depending on whether you enable
the Match Single Character option. The following table shows the resulting strings.

Match Single Character Disabled Match Single Character Enabled


substring before match Test Te

720 ni.com
Functions

Match Single Character Disabled Match Single Character Enabled


match + rest of string string st string

Pick Line Function

Chooses a line from multi-line string and appends that line to string.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string ("") —

string is the string to which LabVIEW appends the string selected from multi-line string. The
default is an empty string.

• multi-line string —

multi-line string contains one or more substrings separated by linefeeds.

• line index —

line index selects the line the function appends from multi-line string.

line index must be numeric. A line index of 0 selects the first line. If line index is negative or is
greater than or equal to the number of lines in multi-line string, the function sets output string
to string.
• output string —

output string is the resulting string.

Match First String Function

Compares each prefix string in string array to the beginning of string until it
encounters a match. This function returns the original input string with the matching

© National Instruments 721


Functions

prefix string removed.

Inputs/Outputs
• string —

string specifies the string to match to the prefixes in string array. The default is an empty string.

• string array —

string array specifies the array of strings that you want to match with string. If the function
encounters an empty string in string array, the function considers that string a match.

• output string —

output string returns the original string with the matching prefix removed. If the beginning of
string does not match any string in string array, output string returns the original string.

• index —

index returns the numeric index of the matching prefix in string array. If the beginning of string
does not match any string in string array, index is –1.

This function compares each string in string array to string in the order in which the
elements are indexed. This function always searches from the beginning of string and
matches the first string prefix that appears at the beginning of string. For example, this
function matches Error 1 in the string Error 16: error occurred if Error
1 comes before Error 16 in string array. However, the function matches Error 16
if Error 16 comes before Error 1 in string array.

Match True/False String Function

Examines the beginning of string to see whether it matches true string or false string.
This function returns a Boolean TRUE or FALSE value in selection, depending on
whether string matches true string or false string.

722 ni.com
Functions

Inputs/Outputs
• string —

string is the input string. The default is an empty string.

• true string —

If true string matches string, selection is TRUE.

• false string —

If false string matches string, selection is FALSE.

• output string —

output string is a shortened version of string with the matching substring removed if either true
string or false string matches the beginning of string. If neither true string nor false string
matches the beginning of string, output string returns string unchanged.

• selection —

selection is TRUE if true string matches the beginning of string, and FALSE if false string
matches the beginning of string, or if neither string matches.

Scan String For Tokens Function

Scans input string starting at offset for tokens and outputs each segment as a token
string.

© National Instruments 723


Functions

Inputs/Outputs
• allow empty tokens? (F) —

allow empty tokens? determines whether the function recognizes a token when it encounters
multiple adjacent delimiters.

If allow empty tokens? is FALSE (default), multiple adjacent delimiters can separate two tokens
in input string. If allow empty tokens? is TRUE, an empty token string is returned between
every pair of adjacent delimiters.
• input string —

input string is the string to scan for tokens.

• offset —

offset is the point in input string to begin scanning.

The default is 0, which specifies the beginning of the string.


• operators (none) —

operators is an array of strings that the function identifies as tokens when they appear in input
string, even if they are not surrounded by delimiters.

If a portion of input string matches more than one defined operator, the function chooses the
longest match as a token. For example, if >, = and >= are defined operators, the input string
4>=0 produces >= as the next token string with an offset of 1.

A string in operators might contain the following special format codes, which you can use to
scan entire numbers as single tokens.

%d match decimal integer


%o match octal integer
%x match hexadecimal integer
%b match binary integer
%e,%f,%g match floating-point or scientific real number
%% match a single % character

Note If the strings + or – are defined as operators, the function does not recognize
leading, or unary, + and – signs. The function always returns them as separate tokens.
This is an exception to the "longest match" rule.

• delimiters (\s,\t,\r,\n) —

724 ni.com
Functions

delimiters is an array of strings that act as separators between tokens.

Strings in delimiters are not returned as tokens but serve to separate adjacent tokens from each
other. The default delimiters are the white space characters: space, tab, linefeed, and carriage
return.

• use cached delim/oper data? (F) —

use cached delim/oper data? is an advanced optional input. If unwired, token string still
behaves correctly.

However, you can use use cached delim/oper data? to greatly improve string parsing
performance. Set use cached delim/oper data? to FALSE the first time token string is executed,
and TRUE each subsequent time as long as operators and delimiters have not changed. Use a
shift register with a constant FALSE coming in and a constant TRUE going out to ensure correct
behavior if operators and delimiters do not change during the execution of the loop. If use
cached delim/oper data? is TRUE and operators or delimiters has changed since the last
execution, incorrect output might result. If both operators and delimiters are unwired or are
wired to block diagram constants, you can leave use cached delim/oper data? unwired and still
achieve optimal performance.

• string out —

string out returns input string unchanged.

• offset past token —

offset past token identifies the point in the input string immediately following the most recently
found token and any trailing delimiters.

Any subsequent scanning of the same input string should begin at this offset. If offset is less
than 0 or greater than the number of characters in input string, or if the end of the string was
reached, offset past token is –1.

• token string —

token string is the matched token. It can be one of the strings in operators or any text string in
input string that appears between delimiters.

• token index —

token index is the index of token string in operators if token string matches one of the elements
in operators.

© National Instruments 725


Functions

If token string is any other string, token index returns –1. If the function reaches the end of input
string without finding any valid operator, token index returns –2.

Tokens are text segments that typically represent individual keywords, numeric values,
or operators found when parsing a configuration file or other text-based data format.
You can specify tokens with the data you pass into the function through the delimiters
and operators inputs. For example, because the space character is a delimiter by
default, each word of This is a string is a token, and you can parse the
sentence into its component words.

Use this function in a While Loop that processes one section of string at a time until
token index returns –2 (indicating end of string). You can pass offset past token
through a shift register into offset, so that each scan starts where the preceding scan
ended.

By default, the function identifies and returns a token when it encounters a space, tab,
carriage return, or linefeed. You can parse a string using these or any other delimiters
you choose or you can define operators.

For example, suppose you wire the following values to the function.

Input Value
input string This is a testLabVIEWstring
offset 0 (default)
operators [NI,asdf,LabVIEW]
delimiters \s,\t,\r,\n (default)

If you place the function in a While Loop, the function returns the following values.

First Iteration

string out This is a testLabVIEWstring


offset past token 5
token string This

726 ni.com
Functions

token index –1 (not an operator)

Second Iteration

string out This is a testLabVIEWstring


offset past token 8
token string is
token index –1 (not an operator)

Third Iteration

string out This is a testLabVIEWstring


offset past token 10
token string a
token index –1 (not an operator)

Fourth Iteration

string out This is a testLabVIEWstring


offset past token 14
token string test
token index –1 (not an operator)

Fifth Iteration

string out This is a testLabVIEWstring


offset past token 21
token string LabVIEW
token index 2 (second item in operators)

© National Instruments 727


Functions

Sixth Iteration

string out This is a testLabVIEWstring


offset past token –1 (no more tokens present)
token string string
token index –1 (not an operator)

Seventh Iteration

string out This is a testLabVIEWstring


offset past token –1 (no more tokens present)
token string (end of string)
token index –2 (end of string)

Search and Replace Pattern

Searches string for substrings that match regular expression and replaces those
substrings with replace string. A regular expression requires a specific combination of
characters for pattern matching. For more information about special characters in
regular expressions, refer to the regular expression input description in the detailed
help.

Inputs/Outputs
• replace all? (F) —

If replace all? is TRUE, the VI replaces all substrings in string that match regular expression.

If FALSE (default), the VI replaces only the first substring in string.

• string —

728 ni.com
Functions

string specifies the input string you want the function to search.

• regular expression ("") —

regular expression is the pattern for which you want to search in string.

You can use special characters in regular expression.

If the VI does not find regular expression, result string is string and offset past match is –1. If
regular expression matches the empty string, the function makes no replacements, result string
is string, and offset past match returns 0 or the length of the string, depending on whether
replace all? is FALSE or TRUE, respectively.

• replace string ("") —

replace string replaces the substring in string that matches regular expression. The default is an
empty string.

• offset (0) —

offset specifies number of characters into string at which the function starts searching for a
match. offset must be numeric.

The offset of the first character in string is 0. If offset is unwired or less than 0, the function takes
offset as 0.

• result string —

result string contains the edited string with the replaced characters.

• offset past match —

offset past match is the index in string of the first character after the last match. If the VI does
not find a match, offset past match is –1.

This VI is similar to the Match Pattern function.

This VI can perform a case-insensitive search or search for more complex patterns than
the Search and Replace String function.

© National Instruments 729


Functions

Index String Array Function

Selects a string specified by index from string array and appends that string to string.

Inputs/Outputs
• string ("") —

string is the string to which LabVIEW appends the string selected from string array. The default
is an empty string.

• string array —

string array is the array from which LabVIEW selects a string according to index to append to
string.

• index —

index must be numeric.

• output string —

output string is string with the string in string array at offset index appended.

If index is less than zero or greater than the number of elements in string array, output string
returns string unchanged.

Append True/False String Function

Selects either a FALSE or TRUE string according to a Boolean selector and appends
that string to string.

730 ni.com
Functions

Inputs/Outputs
• string ("") —

string is the input string. The default is an empty string.

• true string —

true string is the string to append if selector is TRUE.

• false string —

false string is the string to append if selector is FALSE.

• selector —

selector determines whether the function appends true string (TRUE) or false string (FALSE) to
string.

• output string —

output string is the resulting string.

Rotate String Function

Places the first character of string in the last position of first char last, shifting the
other characters forward one position. For example, the string abcd becomes bcda.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string —

string can be a string or any data structure that contains only strings, such as an array or clusters
of strings.

• first char last —

© National Instruments 731


Functions

first char last is the rotated string and has the same structure as string.

Reverse String Function

Produces a string whose characters are in reverse order of those in string.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string —

string can be a string or any data structure that contains only strings, such as an array or clusters
of strings.

• reversed —

reversed is the reversed string and has the same structure as string.

Delimited String to 1D String Array

Converts substrings in a delimited string to the elements of a one-dimensional string


array.

Inputs/Outputs
• delimited string —

delimited string specifies the string with a delimiting character between substrings.

• delimiter —

732 ni.com
Functions

delimiter specifies the character that separates substrings in a delimited string. The default is
\t, which specifies a single tab character.

• string array —

string array returns an array of strings constructed from delimited string.

1D String Array to Delimited String

Converts the elements of a one-dimensional string array to a single string with input
array elements separated by a delimiting character.

Inputs/Outputs
• string array —

string array specifies the one-dimensional array of strings on which the node operates.

• delimiter —

delimiter specifies the character that separates substrings in a delimited string. The default is
\t, which specifies a single tab character.

• delimited string —

delimited string returns a string of concatenated array elements separated by the delimiter you
specify.

Create NI GUID

Generates a globally unique identifier (GUID) string.

© National Instruments 733


Functions

Inputs/Outputs
• NI GUID —

NI GUID returns a globally unique identifier (GUID) string of the following format:
12345678-1234-1234-1234-1234567890AB.

ASCII Codes

ASCII encoding is a 7-bit code (from 0 to 127). It contains upper and lowercase English,
American English punctuation, base 10 numbers, and a few control codes. The first 32
codes (from 0 to 31) are control codes, which are a set of non-printable control
characters used for text formatting.

To represent international characters, single-byte operating systems use an 8-bit


extension of ASCII. The lower 128 character codes are identical to ASCII, and the upper
128 are different for each code page. The various international characters reside in the
upper 128 character codes. Windows, Linux, and macOS use 8-bit character sets, but
they each map differently. Because the upper 128 character sets differ between
operating systems and languages, these are not displayed here.

Dec Oct Hex Ctrl Char ASCII Msg


0 000 00 CTRL-@ NUL —
1 001 01 CTRL-A SOH GTL
2 002 02 CTRL-B STX —
3 003 03 CTRL-C ETX —
4 004 04 CTRL-D EOT SDC
5 005 05 CTRL-E ENQ PPC
6 006 06 CTRL-F ACK —
7 007 07 CTRL-G BEL —
8 010 08 CTRL-H BS GET
9 011 09 CTRL-I HT TCT
10 012 0A CTRL-J LF —

734 ni.com
Functions

Dec Oct Hex Ctrl Char ASCII Msg


11 013 0B CTRL-K VT —
12 014 0C CTRL-L FF —
13 015 0D CTRL-M CR —
14 016 0E CTRL-N SO —
15 017 0F CTRL-O SI —
16 020 10 CTRL-P DLE —
17 021 11 CTRL-Q DC1 LLO
18 022 12 CTRL-R DC2 —
19 023 13 CTRL-S DC3 —
20 024 14 CTRL-T DC4 DCL
21 025 15 CTRL-U NAK PPU
22 026 16 CTRL-V SYN —
23 027 17 CTRL-W ETB —
24 030 18 CTRL-X CAN SPE
25 031 19 CTRL-Y EM SPD
26 032 1A CTRL-Z SUB —
27 033 1B CTRL-[ ESC —
28 034 1C CTRL-\ FS —
29 035 1D CTRL-] GS —
30 036 1E CTRL-^ RS —
31 037 1F CTRL-_ US —
32 040 20 — SP MLA0
33 041 21 — ! MLA1
34 042 22 — " MLA2
35 043 23 — # MLA3
36 044 24 — $ MLA4
37 045 25 — % MLA5

© National Instruments 735


Functions

Dec Oct Hex Ctrl Char ASCII Msg


38 046 26 — & MLA6
39 047 27 — ' MLA7
40 050 28 — ( MLA8
41 051 29 — ) MLA9
42 052 2A — * MLA10
43 053 2B — + MLA11
44 054 2C — , MLA12
45 055 2D — – MLA13
46 056 2E — . MLA14
47 057 2F — / MLA15
48 060 30 — 0 MLA16
49 061 31 — 1 MLA17
50 062 32 — 2 MLA18
51 063 33 — 3 MLA19
52 064 34 — 4 MLA20
53 065 35 — 5 MLA21
54 066 36 — 6 MLA22
55 067 37 — 7 MLA23
56 070 38 — 8 MLA24
57 071 39 — 9 MLA25
58 072 3A — : MLA26
59 073 3B — ; MLA27
60 074 3C — < MLA28
61 075 3D — = MLA29
62 076 3E — > MLA30
63 077 3F — ? UNL
64 100 40 — @ MTA0

736 ni.com
Functions

Dec Oct Hex Ctrl Char ASCII Msg


65 101 41 — A MTA1
66 102 42 — B MTA2
67 103 43 — C MTA3
68 104 44 — D MTA4
69 105 45 — E MTA5
70 106 46 — F MTA6
71 107 47 — G MTA7
72 110 48 — H MTA8
73 111 49 — I MTA9
74 112 4A — J MTA10
75 113 4B — K MTA11
76 114 4C — L MTA12
77 115 4D — M MTA13
78 116 4E — N MTA14
79 117 4F — O MTA15
80 120 50 — P MTA16
81 121 51 — Q MTA17
82 122 52 — R MTA18
83 123 53 — S MTA19
84 124 54 — T MTA20
85 125 55 — U MTA21
86 126 56 — V MTA22
87 127 57 — W MTA23
88 130 58 — X MTA24
89 131 59 — Y MTA25
90 132 5A — Z MTA26
91 133 5B — [ MTA27

© National Instruments 737


Functions

Dec Oct Hex Ctrl Char ASCII Msg


92 134 5C — \ MTA28
93 135 5D — ] MTA29
94 136 5E — ^ MTA30
95 137 5F — _ UNT
96 140 60 — ` MSA0,PPE
97 141 61 — a MSA1,PPE
98 142 62 — b MSA2,PPE
99 143 63 — c MSA3,PPE
100 144 64 — d MSA4,PPE
101 145 65 — e MSA5,PPE
102 146 66 — f MSA6,PPE
103 147 67 — g MSA7,PPE
104 150 68 — h MSA8,PPE
105 151 69 — i MSA9,PPE
106 152 6A — j MSA10,PPE
107 153 6B — k MSA11,PPE
108 154 6C — l MSA12,PPE
109 155 6D — m MSA13,PPE
110 156 6E — n MSA14,PPE
111 157 6F — o MSA15,PPE
112 160 70 — p MSA16,PPD
113 161 71 — q MSA17,PPD
114 162 72 — r MSA18,PPD
115 163 73 — s MSA19,PPD
116 164 74 — t MSA20,PPD
117 165 75 — u MSA21,PPD
118 166 76 — v MSA22,PPD

738 ni.com
Functions

Dec Oct Hex Ctrl Char ASCII Msg


119 167 77 — w MSA23,PPD
120 170 78 — x MSA24,PPD
121 171 79 — y MSA25,PPD
122 172 7A — z MSA26,PPD
123 173 7B — { MSA27,PPD
124 174 7C — | MSA28,PPD
125 175 7D — } MSA29,PPD
126 176 7E — ~ MSA30,PPD
127 177 7F — DEL —

ASCII Conversion Functions

The following is a list of some of the LabVIEW functions that use ASCII codes:

Decimal String To Number

Fract/Exp String To Number

Hexadecimal String To Number

Number To Engineering String

Number To Exponential String

Number To Fractional String

Number To Decimal String

Number To Octal String

Number To Hexadecimal String

Octal String To Number

© National Instruments 739


Functions

String to Byte Array

Format Codes for the Time Format String

The Format Date/Time String function calculates the date and time and formats the
output string according to the following format codes.

Format Code Value


<%a> abbreviated weekday name (for example Wed)
<%A> full weekday name (for example Wednesday)
<%b> abbreviated month name (for example Jun)
<%B> full month name (for example June)
<%c> locale-specific default date and time
<%d> day of month (01–31)
<%H> hour (24-hour clock) (00–23)
<%I> hour (12-hour clock) (01–12)
<%j> day number of the year (001–366)
<%m> month number (01–12)
<%M> minute (00–59)
<%p> AM or PM flag
<%S> second (00–59)
<%<digit>u> fractional seconds with <digit> precision
week number of the year (00–53), with the first Sunday as the first day of week
<%U>
one; 00 represents the first week
<%w> weekday as a decimal number (0–6), with 0 representing Sunday
week number of the year (00–53), with the first Monday as the first day of week
<%W>
one; 00 represents the first week
<%x> locale-specific date
<%.1x> long date format
<%.2x> abbreviated long date format

740 ni.com
Functions

Format Code Value


<%X> locale-specific time
year within century (00–99); when you scan the numbers, numbers (00–68)
<%y> represent years in the twenty-first century (2000–2068) and numbers (69–99)
represent years in the twentieth century (1969–1999)
<%Y> year, including the century (for example, 1997)
<%z> difference between locale time and universal time (HH:MM:SS)
time zone name or abbreviation, depending on the operating system locale
<%Z>
settings

Carriage Return Constant

Consists of a constant string containing the ASCII CR value.

Use this constant when you do not want to type in the backslash code for the
character.

Line Feed Constant

Consists of a constant string containing the ASCII LF value.

Use this constant when you do not want to type in the backslash code for the
character.

End of Line Constant

Consists of a constant string containing the platform-dependent end-of-line value.

(Windows) The value is CR/LF (carriage return/linefeed). (macOS/Linux) The value is


LF.

© National Instruments 741


Functions

Use this constant when you do not want to type in the backslash code for the
character.

Comparison
Use the Comparison functions to compare Boolean values, strings, numeric values,
arrays, and clusters.

The Comparison functions treat Boolean, string, numeric, array, and cluster values
differently. You also can use the Comparison functions to compare characters. You can
change the comparison mode of some Comparison functions.

Palette
Description
Object
Equal? Returns TRUE if x is equal to y. Otherwise, this function returns FALSE. You can
Function change the comparison mode of this function.
Not Equal? Returns TRUE if x is not equal to y. Otherwise, this function returns FALSE. You can
Function change the comparison mode of this function.
Greater? Returns TRUE if x is greater than y. Otherwise, this function returns FALSE. You can
Function change the comparison mode of this function.
Less? Returns TRUE if x is less than y. Otherwise, this function returns FALSE. You can
Function change the comparison mode of this function.
Greater Or
Returns TRUE if x is greater than or equal to y. Otherwise, this function returns FALSE.
Equal?
You can change the comparison mode of this function.
Function
Less Or
Returns TRUE if x is less than or equal to y. Otherwise, this function returns FALSE.
Equal?
You can change the comparison mode of this function.
Function
Equal To 0?
Returns TRUE if x is equal to 0. Otherwise, this function returns FALSE.
Function

742 ni.com
Functions

Palette
Description
Object
Not Equal
To 0? Returns TRUE if x is not equal to 0. Otherwise, this function returns FALSE.
Function
Greater
Than 0? Returns TRUE if x is greater than 0. Otherwise, this function returns FALSE.
Function
Less Than
Returns TRUE if x is less than 0. Otherwise, this function returns FALSE.
0? Function
Greater Or
Equal To 0? Returns TRUE if x is greater than or equal to 0. Otherwise, this function returns FALSE.
Function
Less Or
Equal To 0? Returns TRUE if x is less than or equal to 0. Otherwise, this function returns FALSE.
Function
Returns the value wired to the t input or f input, depending on the value of s. If s is
Select
TRUE, this function returns the value wired to t. If s is FALSE, this function returns the
Function
value wired to f.
Compares x and y and returns the larger value at the top output terminal and the
smaller value at the bottom output terminal. This function accepts time stamp values
Max & Min
if all inputs are time stamp values. If the inputs are time stamp values, the function
Function
returns the later time at the top and the earlier time at the bottom. You can change
the comparison mode of this function.
Determines whether x falls within a range specified by the upper limit and lower limit
In Range inputs and optionally coerces the value to fall within the range. The function performs
and Coerce the coercion only in Compare Elements mode. This function accepts time stamp
Function values if all inputs are time stamp values. You can change the comparison mode of
this function.
Not A
Number/
Returns TRUE if number/path/refnum is not a number (NaN), <Not a Path>, or not a
Path/
refnum. Otherwise, this function returns FALSE.
Refnum?
Function
Empty
Array? Returns TRUE if the input array is empty. Otherwise, this function returns FALSE.
Function

© National Instruments 743


Functions

Palette
Description
Object
Empty
Returns TRUE if string/path is an empty string or an empty path. Otherwise, this
String/
function returns FALSE. This function is also designed to work with variants, pictures,
Path?
and DSC tags.
Function
Returns TRUE if char represents a decimal digit ranging from 0 through 9. If char is a
Decimal string, this function uses the first character in the string. If char is a number, this
Digit? function interprets it as the ASCII value of a character. If char is a floating-point
Function number, this function rounds to the nearest integer. Otherwise, this function returns
FALSE.
Returns TRUE if char represents a hex digit ranging from 0 through 9, A through F, or a
through f. If char is a string, this function uses the first character in the string. If char is
Hex Digit?
a number, this function interprets it as the ASCII value of a character. If char is a
Function
floating-point number, this function rounds to the nearest integer. Otherwise, this
function returns FALSE.
Returns TRUE if char represents an octal digit ranging from 0 through 7. If char is a
string, this function uses the first character in the string. If char is a number, this
Octal Digit?
function interprets it as the ASCII value of a character. If char is a floating-point
Function
number, this function rounds to the nearest integer. Otherwise, this function returns
FALSE.
Returns TRUE if char represents a printable ASCII character. If char is a string, this
Printable? function uses the first character in the string. If char is a number, this function
Function interprets it as the ASCII value of a character. If char is a floating-point number, this
function rounds to the nearest integer. Otherwise, this function returns FALSE.
Returns TRUE if char represents a white space character, such as Space, Tab, Newline,
White Carriage Return, Form Feed, or Vertical Tab. If char is a string, this function uses the
Space? first character in the string. If char is a number, this function interprets it as the ASCII
Function value of a character. If char is a floating-point number, this function rounds to the
nearest integer. Otherwise, the function returns FALSE.
Lexical Returns the class number for char. If char is a string, this function uses the first
Class character in the string. If char is a number, this function interprets it as the ASCII value
Function of a character.

Compares input items you specify to determine whether values are equal, greater
Comparison
than, less than, and so on.

744 ni.com
Functions

Palette
Description
Object

Use the Assert Type VIs and functions in conjunction with the Type Specialization
structure for the following purposes:
Assert Type
• Customizing sections of code in a malleable VI (.vim) for specific data types
• Forcing a malleable VI to accept only data types that meet certain requirements
• Forcing a malleable VI to decline specific data types

Is Value Returns TRUE if this is the first call of this VI or if the input value is different from the
Changed value when this VI was last called.

Is Path and Returns TRUE if path is any value other than <Not A Path> or an empty path.
Not Empty? Otherwise, this VI returns FALSE.
Fixed-Point
Returns TRUE if FXP includes an overflow status and FXP is the result of an operation
Overflow?
that overflowed. Otherwise, this function returns FALSE.
Function

Equal? Function

Returns TRUE if x is equal to y. Otherwise, this function returns FALSE. You can change
the comparison mode of this function.

If you compare two matrices, the default comparison mode is Compare Aggregates,
and this function returns a scalar. You can compare an array or cluster of a data type to
a scalar of the same data type and produce an array or cluster of Boolean values. The
connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

© National Instruments 745


Functions

x is a value to compare to y

• y—

y must be of the same type as x.

• x = y? —

When you compare arrays, x = y? is a scalar in Compare Aggregates mode and a Boolean array in
Compare Elements mode (default).

When comparing VI Server references, this function returns TRUE when the two
references refer to the same object, regardless of whether the references have the
same capability or the same value. For example, one might be a strict reference to a
digital numeric control and the other might be a generic reference but if they refer to
the same object, they are equal. To compare the actual values of the references, use
the Type Cast function to convert the references to 32-bit signed integers. Then use the
Equal? function to compare those integers.

Similarly to the previous situation, if you have a local reference and a remote reference
to the same LabVIEW object, this function returns FALSE. However, when two
references refer to the same object but one of them is authenticated and the other is
not, this function still returns TRUE.

Note If you compare two inputs with the value not a number, NaN, or one
input with the value NaN to an input with another value, this function always
returns FALSE. Use the Not a Number/Path/Refnum? function to compare one
or more inputs with a value of NaN.

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

746 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Comparison Functions.vi

Not Equal? Function

Returns TRUE if x is not equal to y. Otherwise, this function returns FALSE. You can
change the comparison mode of this function.

If you compare two matrices, the default comparison mode is Compare Aggregates,
and this function returns a scalar. You can compare an array or cluster of a data type to
a scalar of the same data type and produce an array or cluster of Booleans. The
connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

xis a value to compare to y

• y—
y must be of the same type as x
• x != y? —

x!=y? returns the Boolean result of the operation. When you compare arrays, x!=y? is a scalar in
Compare Aggregates mode and a Boolean array in Compare Elements mode (default).

When comparing VI Server references, this function returns FALSE when the two
references refer to the same object, regardless of whether the references have the
same capability or the same value. For example, one might be a strict reference to a
digital numeric control and the other might be a generic reference but if they refer to
the same object, they are equal. To compare the actual values of the references, use
the Type Cast function to convert the references to 32-bit signed integers. Then use the

© National Instruments 747


Functions

Not Equal? function to compare those integers.

Similarly to the previous situation, if you have a local reference and a remote reference
to the same LabVIEW object, this function returns TRUE. However, when two
references refer to the same object but one of them is authenticated and the other is
not, this function still returns FALSE.

Note If you compare two inputs with the value not a number, NaN, or one
input with the value NaN to an input with another value, this function always
returns TRUE. Use the Not a Number/Path/Refnum? function to compare one
or more inputs with a value of NaN.

When you wire matrix data as an input to this function, a VI that includes subVIs that
work with the matrix data type replaces the function. The resulting VI has the same
icon but contains a matrix-specific algorithm. The node remains a VI if you disconnect
the matrix from the input(s). Wire other data types as inputs to restore the original
function. If you wire a data type to a function and that data type causes a basic math
operation to fail, the function returns an empty matrix or NaN.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Comparison Functions.vi

Greater? Function

Returns TRUE if x is greater than y. Otherwise, this function returns FALSE. You can
change the comparison mode of this function.

You can compare an array or cluster of a data type to a scalar of the same data type
and produce an array or cluster of Boolean values. The connector pane displays the
default data types for this polymorphic function.

748 ni.com
Functions

Inputs/Outputs
• x—

x is a value to compare to y

• y—

y must be of the same type as x

• x > y? —

x > y? returns the Boolean result of the operation.

When you compare arrays, x > y? is a scalar in Compare Aggregates mode and a Boolean array in
Compare Elements mode (default).

Less? Function

Returns TRUE if x is less than y. Otherwise, this function returns FALSE. You can change
the comparison mode of this function.

You can compare an array or cluster of a data type to a scalar of the same data type
and produce an array or cluster of Boolean values. The connector pane displays the
default data types for this polymorphic function.

Inputs/Outputs
• x—

x is a value to compare to y

• y—

y must be of the same type as x

• x < y? —

© National Instruments 749


Functions

x < y? returns the Boolean result of the operation. When you compare arrays, x < y? is a scalar in
Compare Aggregates mode and a Boolean array in Compare Elements mode (default).

Greater Or Equal? Function

Returns TRUE if x is greater than or equal to y. Otherwise, this function returns FALSE.
You can change the comparison mode of this function.

You can compare an array or cluster of a data type to a scalar of the same data type
and produce an array or cluster of Boolean values. The connector pane displays the
default data types for this polymorphic function.

Inputs/Outputs
• x—

x is a value to compare to y

• y—

y must be of the same type as x

• x >= y? —

x >= y? returns the Boolean result of the operation.

When you compare arrays, x >= y? is a scalar in Compare Aggregates mode and a Boolean array
in Compare Elements mode (default).

Less Or Equal? Function

Returns TRUE if x is less than or equal to y. Otherwise, this function returns FALSE. You
can change the comparison mode of this function.

750 ni.com
Functions

You can compare an array or cluster of a data type to a scalar of the same data type
and produce an array or cluster of Boolean values. The connector pane displays the
default data types for this polymorphic function.

Inputs/Outputs
• x—

x is a value to compare to y

• y—

y must be of the same type as x

• x <= y? —

x ≤ y? returns the Boolean result of the operation. When you compare arrays, x ≤ y? is a scalar in
Compare Aggregates mode and a Boolean array in Compare Elements mode (default).

Equal To 0? Function

Returns TRUE if x is equal to 0. Otherwise, this function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a numeric scalar value, cluster, array of numbers, or a time stamp value.

• x = 0? —

© National Instruments 751


Functions

x = 0? is a Boolean value of the same data type structure as x.

Not Equal To 0? Function

Returns TRUE if x is not equal to 0. Otherwise, this function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a numeric scalar value, cluster, array of numbers, or a time stamp value.

• x != 0? —

x!= 0? is a Boolean value of the same data type structure as x.

Greater Than 0? Function

Returns TRUE if x is greater than 0. Otherwise, this function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a numeric scalar value, cluster, array of numbers, or a time stamp value.

• x > 0? —

752 ni.com
Functions

x > 0? is a Boolean value of the same data type structure as x.

Less Than 0? Function

Returns TRUE if x is less than 0. Otherwise, this function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a numeric scalar value, cluster, array of numbers, or a time stamp value.

• x < 0? —

x < 0? is a Boolean value of the same data type structure as x.

Greater Or Equal To 0? Function

Returns TRUE if x is greater than or equal to 0. Otherwise, this function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a numeric scalar value, cluster, array of numbers, or a time stamp value.

• x >= 0? —

© National Instruments 753


Functions

x >= 0? is a Boolean value of the same data type structure as x.

Less Or Equal To 0? Function

Returns TRUE if x is less than or equal to 0. Otherwise, this function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

x can be a numeric scalar value, cluster, array of numbers, or a time stamp value.

• x <= 0? —

x ≤ 0? is a Boolean value of the same data type structure as x.

Select Function

Returns the value wired to the t input or f input, depending on the value of s. If s is
TRUE, this function returns the value wired to t. If s is FALSE, this function returns the
value wired to f.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• t—

754 ni.com
Functions

t is the value that this function returns if s passes a TRUE value.

t and f must be of the same type, but they can have different numeric representations.
• s—

s determines whether the function returns the value of t or f in s? t:f.

If you wire an error cluster to s and an error occurs, the error cluster passes a TRUE value to the
function. Otherwise, the error cluster passes a FALSE value to the function.
• f—

f is the value that this function returns if s passes a FALSE value.

t and f must be of the same type, but they can have different numeric representations.
• s? t:f —

s? t:f is the value wired to t if s is TRUE. s? t:f is the value wired to f if s is FALSE.

Max & Min Function

Compares x and y and returns the larger value at the top output terminal and the
smaller value at the bottom output terminal. This function accepts time stamp values
if all inputs are time stamp values. If the inputs are time stamp values, the function
returns the later time at the top and the earlier time at the bottom. You can change the
comparison mode of this function.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• x—

xis a value to compare to y

• y—

© National Instruments 755


Functions

y must be of the same type as x

• max(x,y) —

max(x, y) is the larger value. When you compare arrays in Compare Elements mode (default),
this function compares corresponding elements in each input array and returns the element
with the maximum value. max(x, y) is an array consisting of the maximum value elements. When
you compare arrays in Compare Aggregates mode, this function compares corresponding
elements in each input array starting at the beginning of the array. When this function reaches a
pair of unequal corresponding elements, max(x, y) returns the array that has the greater value
for that element.

• min(x,y) —

min(x, y) is the smaller value. When you compare arrays in Compare Elements mode (default),
this function compares corresponding elements in each input array and returns the element
with the minimum value. min(x, y) is an array consisting of the minimum value elements. When
you compare arrays in Compare Aggregates mode, this function compares corresponding
elements in each input array starting at the beginning of the array. When this function reaches a
pair of unequal corresponding elements, min(x, y) returns the array that has the smaller value
for that element.

Behavior When Comparing NaN Elements

In Compare Elements mode, when one or both inputs are NaN (Not-a-Number), this
function produces the following results:

• Both inputs are NaN—Both max(x,y) and min(x,y) return NaN


• Only one input is NaN—Both max(x,y) and min(x,y) return the non-NaN value
• Inputs are arrays—The function evaluates each pair of elements according to the
previous rules

In Compare Aggregates mode, when one or both inputs are NaN (Not-a-Number), this
function produces the following results:

• Both inputs are NaN—Both max(x,y) and min(x,y) return NaN


• Only one input is NaN—max(x,y) returns x and min(x,y) returns y
• Inputs are arrays—If the function encounters a NaN element in either input array,
max(x,y) returns x and min(x,y) returns y

756 ni.com
Functions

In Range and Coerce Function

Determines whether x falls within a range specified by the upper limit and lower limit
inputs and optionally coerces the value to fall within the range. The function performs
the coercion only in Compare Elements mode. This function accepts time stamp values
if all inputs are time stamp values. You can change the comparison mode of this
function.

upper limit, x, and lower limit should usually be of the same data type structure,
either arrays or clusters, but they can have different numeric representations.

For example, if you change one of the data types to an array, you must change the
remaining data types to arrays to avoid broken wires. However, you can wire an array
to x and two scalars to upper limit and lower limit. You also can wire double-
precision, floating-point and integer data.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• upper limit —

upper limit of the range.

• x—

x is the value to check and/or coerce.

• lower limit —

lower limit of the range.

• coerced(x) —

coerced(x) returns the coerced or unchanged value of x. If x is within the range set by the upper
limit and lower limit inputs or if the function is in Compare Aggregates mode, the value is

© National Instruments 757


Functions

unchanged. If x is not in range and the function is in Compare Elements mode, the function
converts the value to the same value as upper limit or lower limit. If upper limit, x, or lower
limit is NaN, coerced(x) is NaN.

• In Range? —

In Range? is a Boolean value in Compare Aggregates mode. In Compare Elements mode, the
data type structure of In Range? matches the data type structure of x, with each scalar replaced
by a Boolean value. If upper limit, x, or lower limit is NaN, In Range? is FALSE.

This function compares the input data values according to the Boolean comparison
rules. If the function is in Compare Aggregates mode, it returns the unchanged value of
x in coerced(x) rather than a coerced value. The function considers each input array as
a single aggregate object, similar to a cluster, where the first element is primary in the
comparison. If x is greater than upper limit and the function is in Compare Elements
mode (default), the function coerces x to the upper limit value. If x is less than lower
limit and the function is in Compare Elements mode, the function coerces x to the
lower limit value.

If you wire a combination of signed and unsigned integers to the upper limit, x, and
lower limit inputs of the In Range and Coerce function, all of the inputs will be coerced
to the same unsigned integer type. This can lead to unexpected results for negative
input values. For example, wiring an unsigned integer to upper limit and a negative
signed integer to lower limit may cause LabVIEW to interpret the lower limit input as
larger than the upper limit input. To avoid this issue, convert integer inputs to the
same type before you wire them to the In Range and Coerce function.

If the lower limit value is greater than the upper limit value, In Range? is always FALSE
and LabVIEW switches the lower limit value and the upper limit value internally before
computing coerced(x).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\In Range and Coerce.vi

758 ni.com
Functions

Not A Number/Path/Refnum? Function

Returns TRUE if number/path/refnum is not a number (NaN), <Not a Path>, or not a


refnum. Otherwise, this function returns FALSE.

Use this function to make sure a reference to an object, such as a VI, application, or
control, still resides in system memory and was not closed.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• number/path/refnum —

number/path/refnum can be a scalar number, path, or refnum, or it can be a cluster or array of


numbers, paths, or refnums.

• NaN/Path/Refnum? —

NaN/Path/Refnum? is a Boolean value of the same data type structure as number/path/refnum.

This function works only on references generated by LabVIEW functions. Do not use
this function to determine the validity of a rendezvous refnum, semaphore refnum, or
any refnum created by the GOOP wizard, LabVIEW Database Connectivity Toolkit, or
LabVIEW Internet Toolkit. For rendezvous refnums, use the Not A Rendezvous VI. For
semaphore refnums, use the Not A Semaphore VI. For all other GOOP refnums or
toolkit refnums, use the Vis defined by the refnum creator.

To avoid race conditions when evaluating the refnum status, National Instruments
recommends limiting the usage of this function in the following ways:

• Do not use this function to evaluate whether a refnum is invalid before using the
refnum.
• Use this function in custom probes to get the refnum status.
• Use this function to evaluate the status of an existing invalid refnum before

© National Instruments 759


Functions

evaluating a new refnum.


• Use this function to evaluate the status of a refnum before using another refnum.
• Consider using semaphores to protect code that the function executes
conditionally.

Empty Array? Function

Returns TRUE if the input array is empty. Otherwise, this function returns FALSE.

Inputs/Outputs
• array —

array specifies an n-dimensional array of any type.

• empty? —

empty? is TRUE if array is empty. Otherwise, empty? is FALSE.

Empty String/Path? Function

Returns TRUE if string/path is an empty string or an empty path. Otherwise, this


function returns FALSE. This function is also designed to work with variants, pictures,
and DSC tags.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• string/path —

760 ni.com
Functions

string/path can be a string, a path, a variant, a picture string, a DSC tag, or an array or a cluster
of these types.

• empty? —

empty? is a Boolean value of the same data type structure as string/path.

Decimal Digit? Function

Returns TRUE if char represents a decimal digit ranging from 0 through 9. If char is a
string, this function uses the first character in the string. If char is a number, this
function interprets it as the ASCII value of a character. If char is a floating-point
number, this function rounds to the nearest integer. Otherwise, this function returns
FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• char —

char can be a scalar string or number, clusters of strings or numbers, arrays of strings or
numbers, and so on.

• digit? —

digit? is a Boolean value of the same data type structure as char.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Compare Character Types.vi

© National Instruments 761


Functions

Hex Digit? Function

Returns TRUE if char represents a hex digit ranging from 0 through 9, A through F, or a
through f. If char is a string, this function uses the first character in the string. If char is
a number, this function interprets it as the ASCII value of a character. If char is a
floating-point number, this function rounds to the nearest integer. Otherwise, this
function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• char —

char can be a scalar string or number, clusters of strings or numbers, arrays of strings or
numbers, and so on.

• hex? —

hex? is a Boolean value of the same data type structure as char.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Compare Character Types.vi

Octal Digit? Function

Returns TRUE if char represents an octal digit ranging from 0 through 7. If char is a
string, this function uses the first character in the string. If char is a number, this
function interprets it as the ASCII value of a character. If char is a floating-point
number, this function rounds to the nearest integer. Otherwise, this function returns
FALSE.

762 ni.com
Functions

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• char —

char can be a scalar string or number, clusters of strings or numbers, arrays of strings or
numbers, and so on.

• octal? —

octal? is a Boolean value of the same data type structure as char.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Compare Character Types.vi

Printable? Function

Returns TRUE if char represents a printable ASCII character. If char is a string, this
function uses the first character in the string. If char is a number, this function
interprets it as the ASCII value of a character. If char is a floating-point number, this
function rounds to the nearest integer. Otherwise, this function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• char —

© National Instruments 763


Functions

char can be a scalar string or number, clusters of strings or numbers, arrays of strings or
numbers, and so on.

• printable ASCII? —

printable ASCII? is a Boolean value of the same data type structure as char.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Compare Character Types.vi

White Space? Function

Returns TRUE if char represents a white space character, such as Space, Tab, Newline,
Carriage Return, Form Feed, or Vertical Tab. If char is a string, this function uses the
first character in the string. If char is a number, this function interprets it as the ASCII
value of a character. If char is a floating-point number, this function rounds to the
nearest integer. Otherwise, the function returns FALSE.

The connector pane displays the default data types for this polymorphic function.

Inputs/Outputs
• char —

char can be a scalar string or number, clusters of strings or numbers, arrays of strings or
numbers, and so on.

• space, h/v tab, cr, lf, ff? —

space, h/v tab, cr, lf, ff? is a Boolean value of the same data type structure as char.

764 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Compare Character Types.vi

Lexical Class Function

Returns the class number for char. If char is a string, this function uses the first
character in the string. If char is a number, this function interprets it as the ASCII value
of a character.

Inputs/Outputs
• char —

char can be a scalar string or number, clusters of strings or numbers, arrays of strings or
numbers, and so on.

• class number —

class number is a number that corresponds to the lexical class.

Refer to the ASCII Codes table for the numbers that correspond to each character.

Class
Lexical Class
Number
0 Extended characters (codes 128 through 255)
1 Non-displayable ASCII characters (codes 0 to 31 excluding 9 through 13)
White space characters: Space, Tab, Carriage Return, Form Feed, Newline, and Vertical
2
Tab (codes 32, 9, 13, 12, 10, and 11, respectively)
3 Digits 0 through 9
4 Uppercase characters A through Z
5 Lowercase characters a through z
6 All printable ASCII non-alphanumeric characters

© National Instruments 765


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Comparison\Compare Character Types.vi

Comparison

Compares input items you specify to determine whether values are equal, greater
than, less than, and so on.

Dialog Box Options

Option Description
Contains the following options:

• Data points—Compares the data points of the signals in Operand 1 to the data
points of the signals in Operand 2, the value you specify in Value, or the
Constant Value to Compare Against input.
• Timestamps—Compares the initial time stamps (t0) of the signals in Operand 1
to the initial time stamps (t0) of the signals in Operand 2, the value you specify in
Value, or the Constant Value to Compare Against input.
• Time between points—Compares the time between points (dt) of the signals in
Operand 1 to the time between points (dt) of the signals in Operand 2, the value
you specify in Value, or the Constant Value to Compare Against input.
Items to
• Number of data points—Compares the number of data points of the signals in
Compare
Operand 1 to the number of data points of the signals in Operand 2, the value
you specify in Value, or the Constant Value to Compare Against input.
• Signal name—Compares the signal names of the signals in Operand 1 to the
signal names of the signals in Operand 2, the value you specify in Value, or the
Constant Value to Compare Against input. When comparing signal names, you
can use wildcards to match strings. You can use the question mark character (?)
to match any single character. You can use the asterisk character (*) to match any
sequence of zero or more characters.

If you select Signal name, the Comparison Condition section is disabled and set

766 ni.com
Functions

Option Description

to = Equal.

Contains the following options:

• = Equal—

Determines if two inputs are equal.

Because all comparison operations are floating-point operations, consider using


Equal within tolerance for equality comparisons.

• <> Not equal—

Determines if two inputs are unequal.

• > Greater—

Determines if the first input is greater than the second input.

• >= Greater or equal—

Compare Determines if the first input is greater than or equal to the second input.
Condition
• < Less—

Determines if the first input is less than the second input.

• <= Less than or equal—

Determines if the first input is less than or equal to the second input.

• Equal within tolerance—

Determines if the inputs are equal within the tolerance you specify in Tolerance.

◦ Tolerance—

Specifies the level of tolerance to use when determining if an input is Equal


within tolerance. The default is 0.01.

• In range—

© National Instruments 767


Functions

Option Description

Determines if an input falls in the range Minimum and Maximum specify.

• Out of range—

Determines if an input falls out of the range Minimum and Maximum specify.

• Minimum—

Specifies the minimum value of the In range and Out of range comparisons. The
Express VI includes Minimum in the range. The default is 0.

• Maximum—

Specifies the maximum value of the In range and Out of range comparisons. The
Express VI includes Maximum in the range. The default is 1.

Contains the following options:

• Second signal input—

Compares the Operand 1 input of the Express VI to a second signal input as


opposed to a value you specify in Value or the Constant Value to Compare
Against input. Select this option to include the Operand 2 input on the Express
VI.

If Operand 1 and Operand 2 are the same size, each item in Operand 1 is
compared to the corresponding item in Operand 2. If Operand 1 and Operand 2
Comparison are of different sizes, all the items in Operand 1 are compared to the first item in
Inputs Operand 2.

• Value—

Compares the Operand 1 input to a constant value you specify. The default is 0. If
you wire the Constant Value to Compare Against input, the VI uses the value
that this input specifies instead.

◦ Point value—

Specifies the constant value with which to compare the Operand 1 input.
The default is 0.

768 ni.com
Functions

Option Description

◦ Timestamp value—

Specifies the timestamp to apply to the signal.

This option is available only if you place a checkmark in the Timestamp


checkbox.

◦ Delta time value—

Specifies the constant value with which to compare the Operand 1 input.
The default is 0.

◦ Number of points value—

Specifies the number of points to compare. The default is 0.

◦ Signal name value—

Specifies the name of the signal.

Contains the following options:

• One result per data point—

Returns one result per data point. This option is available only when you select
Data points from the Items to Compare pull-down menu.

• One result per channel—

Returns one result per channel. When you select Data points from the Items to
Result Compare pull-down menu, One result per channel returns 1 only if all data
points in the channel pass the specified comparison. If any point fails, it returns
0.

• One result for all channels—

Returns one result for all the channels. When you select Data points from the
Items to Compare pull-down menu, One result for all channels returns 1 only if
all data points in the channels pass the specified comparison. If any point fails, it
returns 0.

© National Instruments 769


Functions

Option Description

• Invert result—

Inverts the outputs.

Contains the following option:

• Change Express VI name to name of function—


Result
Name Changes the name of the Express VI on the block diagram to the name of the
function you select in the Comparison Condition section of the configuration
dialog box.

Displays the input signal.

Input Signal If you wire data to the Express VI and run it, Input Signal displays real data. If you
close and reopen the Express VI, Input Signal displays sample data until you run the
Express VI again.

Contains the following options:

Result If you wire data to the Express VI and run the VI, Result Preview displays real data. If
Preview you close and reopen the Express VI, Result Preview displays sample data until you
run the VI again. If the cutoff frequency values are invalid, Result Preview does not
display valid data.

Inputs/Outputs
• error in (no error) —

Describes error conditions that occur before this node runs.

• Operand 2 —

Specifies the second signal input for comparison. This input is available only when you select
Second signal input in the configuration dialog box.

• Constant Value to Compare Against —

770 ni.com
Functions

Specifies the constant value with which to compare the Operand 1 input. If Constant Value to
Compare Against is not wired, the VI uses the Value specified in the configuration dialog box.

• Operand 1 —

Specifies the first input for comparison.

• Invert Output —

Inverts the outputs.

• Result —

Returns the resulting data based on the configuration of the Express VI.

• error out —

Contains error information. This output provides standard error out functionality.

Components

Specifies the timestamp to apply to the signal.

Specifies the name of the signal.

Specifies the number of points to compare. The default is 0.

Specifies the constant value with which to compare the Operand 1 input. The default
is 0.

Contains the following options:

Displays the input signal.

Contains the following options:

Inverts the outputs.

Returns one result for all the channels. When you select Data points from the Items to
Compare pull-down menu, One result for all channels returns 1 only if all data points

© National Instruments 771


Functions

in the channels pass the specified comparison. If any point fails, it returns 0.

Returns one result per channel. When you select Data points from the Items to
Compare pull-down menu, One result per channel returns 1 only if all data points in
the channel pass the specified comparison. If any point fails, it returns 0.

Returns one result per data point. This option is available only when you select Data
points from the Items to Compare pull-down menu.

Compares the Operand 1 input to a constant value you specify. The default is 0. If you
wire the Constant Value to Compare Against input, the VI uses the value that this
input specifies instead.

Compares the Operand 1 input of the Express VI to a second signal input as opposed to
a value you specify in Value or the Constant Value to Compare Against input. Select
this option to include the Operand 2 input on the Express VI.

Specifies the constant value with which to compare the Operand 1 input. The default
is 0.

Specifies the level of tolerance to use when determining if an input is Equal within
tolerance. The default is 0.01.

Specifies the maximum value of the In range and Out of range comparisons. The
Express VI includes Maximum in the range. The default is 1.

Specifies the minimum value of the In range and Out of range comparisons. The
Express VI includes Minimum in the range. The default is 0.

Determines if an input falls out of the range Minimum and Maximum specify.

Determines if an input falls in the range Minimum and Maximum specify.

Determines if the inputs are equal within the tolerance you specify in Tolerance.

Determines if the first input is less than or equal to the second input.

Determines if the first input is less than the second input.

772 ni.com
Functions

Determines if the first input is greater than or equal to the second input.

Determines if the first input is greater than the second input.

Determines if two inputs are unequal.

Determines if two inputs are equal.

Changes the name of the Express VI on the block diagram to the name of the function
you select in the Comparison Condition section of the configuration dialog box.

Assert Type

Use the Assert Type VIs and functions in conjunction with the Type Specialization
structure for the following purposes:

• Customizing sections of code in a malleable VI (.vim) for specific data types


• Forcing a malleable VI to accept only data types that meet certain requirements
• Forcing a malleable VI to decline specific data types

Palette
Description
Object
Has one or more subdiagrams, exactly one of which LabVIEW compiles and
executes, depending on the order and the compilation result of the subdiagram.
LabVIEW declines subdiagrams in order if they have syntax errors. LabVIEW accepts
the first subdiagram that does not have syntax errors and ignores the remaining
Type subdiagrams. If all subdiagrams have syntax errors, this structure accepts the last
Specialization subdiagram. Syntax errors are errors within the structure, such as broken wires, not
Structure errors caused by subVIs or other dependencies. Use this structure to customize
sections of code in a malleable VI (.vim) for specific data types. You also can use this
structure in conjunction with the Assert Type VIs and functions to force a malleable
VI to accept only a subset of the acceptable data types or to decline specific data
types.
Assert
Breaks the calling VI unless the two input data types are identical, ignoring type
Structural
definitions and type names.
Type Match

© National Instruments 773


Functions

Palette
Description
Object
Function
Assert
Structural Breaks the calling VI if type is the same data type as any of the mismatch inputs,
Type ignoring type definitions and type names.
Mismatch

Breaks the calling VI unless the input data is an error cluster.


Assert Error
Cluster Type This VI does nothing at run time. Use this VI in conjunction with the Type
VI Specialization structure to customize sections of code in a malleable VI (.vim) for
error clusters or to force a malleable VI to accept error clusters only.

Breaks the calling VI unless value in is an array with the same number of
dimensions as array type.

Assert Array To check if each dimension has the same size, use the Assert Array Dimension Sizes
Dimension VI.
Count VI
This VI does nothing at run time. Use this VI in conjunction with the Type
Specialization structure to customize sections of code in a malleable VI (.vim) for
certain array types or to force a malleable VI to accept certain array types only.

Breaks the calling VI unless value in is an array with the same number of
dimensions as array type and each dimension in value in has the same size
requirement (fixed, bounded, or variable-sized) and size (for fixed and bounded) as
the corresponding dimension in array type.
Assert Array
Dimension If you do not need to compare the size of each dimension, use the Assert Array
Sizes VI Dimension Count VI.

This VI does nothing at run time. Use this VI in conjunction with the Type
Specialization structure to customize sections of code in a malleable VI (.vim) for
certain array types or to force a malleable VI to accept certain array types only.

Assert Same
or Breaks the calling VI unless the input data is the same as or is a descendant of the
Descendant

774 ni.com
Functions

Palette
Description
Object

input class or interface.

This VI does nothing at run time. Use this VI in conjunction with the Type
Type VI Specialization structure to customize sections of code in a malleable VI (.vim) for
the specified class or interface or the descendants of the specified class or interface
or to force a malleable VI to accept the specified class or interface or the
descendants of the specified class or interface only.

Breaks the calling VI unless the input data is a scalar numeric or analog waveform
type.
Assert Scalar
Numeric Or
This VI does nothing at run time. Use this VI in conjunction with the Type
Waveform
Specialization structure to customize sections of code in a malleable VI (.vim) for
Type VI
scalar numeric or waveform types or to force a malleable VI to accept scalar
numeric or waveform types only.

Breaks the calling VI unless the input data is a scalar numeric type.
Assert Scalar
Numeric Type This VI does nothing at run time. Use this VI in conjunction with the Type
VI Specialization structure to customize sections of code in a malleable VI (.vim) for
scalar numeric types or to force a malleable VI to accept scalar numeric types only.

Breaks the calling VI unless the input data is a non-complex numeric or analog
waveform type.
Assert Real
Numeric Or
This VI does nothing at run time. Use this VI in conjunction with the Type
Waveform
Specialization structure to customize sections of code in a malleable VI (.vim) for
Type VI
non-complex numeric or waveform types or to force a malleable VI to accept non-
complex numeric or analog waveform types only.

Breaks the calling VI unless the input data is a non-complex numeric type.
Assert Real
Numeric Type
This VI does nothing at run time. Use this VI in conjunction with the Type
VI
Specialization structure to customize sections of code in a malleable VI (.vim) for

© National Instruments 775


Functions

Palette
Description
Object

non-complex numeric types or to force a malleable VI to accept non-complex


numeric types only.

Breaks the calling VI unless the input data is a floating-point, complex floating-
point, or fixed-point numeric type.
Assert
Fractional This VI does nothing at run time. Use this VI in conjunction with the Type
Numeric Type Specialization structure to customize sections of code in a malleable VI (.vim) for
VI floating-point, complex floating-point, or fixed-point numeric types or to force a
malleable VI to accept floating-point, complex floating-point, or fixed-point
numeric types only.

Breaks the calling VI unless the input data is a complex numeric type.
Assert
Complex This VI does nothing at run time. Use this VI in conjunction with the Type
Numeric Type Specialization structure to customize sections of code in a malleable VI (.vim) for
VI complex numeric types or to force a malleable VI to accept complex numeric types
only.

Breaks the calling VI unless the input data is a floating-point or complex floating-
Assert point numeric type.
Floating-
Point This VI does nothing at run time. Use this VI in conjunction with the Type
Numeric Type Specialization structure to customize sections of code in a malleable VI (.vim) for
VI floating-point or complex floating-point numeric types or to force a malleable VI to
accept floating-point or complex floating-point numeric types only.

Breaks the calling VI unless the input data is a non-complex floating-point numeric
Assert Real type.
Floating-
Point This VI does nothing at run time. Use this VI in conjunction with the Type
Numeric Type Specialization structure to customize sections of code in a malleable VI (.vim) for
VI non-complex floating-point numeric types or to force a malleable VI to accept non-
complex floating-point numeric types only.

776 ni.com
Functions

Palette
Description
Object

Breaks the calling VI unless the input data is an integer numeric type.

Assert Integer This VI does nothing at run time. Use this VI in conjunction with the Type
Type VI Specialization structure to customize sections of code in a malleable VI (.vim) for
integer numeric types or to force a malleable VI to accept integer numeric types
only.

Breaks the calling VI unless the input data is a signed integer numeric type.
Assert Signed
This VI does nothing at run time. Use this VI in conjunction with the Type
Integer Type
Specialization structure to customize sections of code in a malleable VI (.vim) for
VI
signed integer numeric types or to force a malleable VI to accept signed integer
numeric types only.

Breaks the calling VI unless the input data is an unsigned integer numeric type.
Assert
Unsigned This VI does nothing at run time. Use this VI in conjunction with the Type
Integer Type Specialization structure to customize sections of code in a malleable VI (.vim) for
VI unsigned integer numeric types or to force a malleable VI to accept unsigned
integer numeric types only.

Breaks the calling VI unless the input data is a fixed-point numeric type.
Assert Fixed-
Point This VI does nothing at run time. Use this VI in conjunction with the Type
Numeric Type Specialization structure to customize sections of code in a malleable VI (.vim) for
VI fixed-point numeric data types or to force a malleable VI to accept fixed-point
numeric types only.

Type Specialization Structure

Has one or more subdiagrams, exactly one of which LabVIEW compiles and executes,
depending on the order and the compilation result of the subdiagram. LabVIEW
declines subdiagrams in order if they have syntax errors. LabVIEW accepts the first
subdiagram that does not have syntax errors and ignores the remaining subdiagrams.

© National Instruments 777


Functions

If all subdiagrams have syntax errors, this structure accepts the last subdiagram.
Syntax errors are errors within the structure, such as broken wires, not errors caused
by subVIs or other dependencies. Use this structure to customize sections of code in a
malleable VI (.vim) for specific data types. You also can use this structure in
conjunction with the Assert Type VIs and functions to force a malleable VI to accept
only a subset of the acceptable data types or to decline specific data types.

After you create a Type Specialization structure, you can add, duplicate, rearrange, or
delete the subdiagrams. To scroll through the available subdiagrams, click the
decrement and increment arrows in the selector label. You also can remove the
structure without deleting objects in the structure.

The Type Specialization structure allows you to disable specific sections of code on the
block diagram based on compilation results. To disable specific sections of code on
the block diagram based on some user-defined condition, use the Conditional Disable
structure. To disable a section of a block diagram, use the Diagram Disable structure.

To switch to a Conditional Disable or Diagram Disable structure, right-click the border


of the Type Specialization structure and select Replace with Conditional Disable
Structure or Replace with Diagram Disable Structure from the shortcut menu.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Type Specialization


Structure\Malleable VIs - Type Specialization
Structure.lvproj

Assert Structural Type Match Function

Breaks the calling VI unless the two input data types are identical, ignoring type
definitions and type names.

778 ni.com
Functions

This function does nothing at run time. Use this function in conjunction with the Type
Specialization structure to customize sections of code in a malleable VI (.vim) for
specific data types or to force a malleable VI to accept only data types that meet
certain requirements.

Inputs/Outputs
• anything —

anything specifies the first input data type.

LabVIEW ignores any run-time value on the wire connected to this input.

• reference —

reference specifies the second input data type, which you want to compare against x.

To set the data type of this input, wire a constant or control of the desired data type to reference.
LabVIEW ignores any run-time value on the wire connected to this input.

For data types with subtypes, such as arrays, clusters, and some refnums, this function
also checks array dimensions and subtypes, but not the subtype names. For example,
this function causes the calling VI to break if one input data type is 1D array of variant
and the other is 2D array of variant or 1D array of scalars. If one input data type is a
cluster of a string named lecture and an unsigned 8-bit integer named number of
students, while the other input data type is a cluster of a string named lecture 1
and an unsigned 8-bit integer named size, the calling VI does not break because the
subtypes of the two clusters are the same even though the subtype names are
different.

Assert Structural Type Mismatch

Breaks the calling VI if type is the same data type as any of the mismatch inputs,
ignoring type definitions and type names.

This function does nothing at run time. Use this function in conjunction with the Type

© National Instruments 779


Functions

Specialization structure to customize sections of code in a malleable VI (.vim) for


specific data types or to force a malleable VI to decline specific data types.

Inputs/Outputs
• type —

type specifies the input data type.

LabVIEW ignores any run-time value on the wire connected to this input.

• mismatch —

mismatch specifies the data type that you want to compare against type.

To set the data type of this input, wire a constant or control of the desired data type to
mismatch. Wire one data type to each mismatch input you want to compare against type.
LabVIEW ignores any run-time value on the wire connected to this input.

Avoiding Unexpected Behavior in Your Malleable VI

To avoid unexpected behavior in your malleable VI, you can use this function to force a
specific subdiagram of your Type Specialization structure to decline data types that
you intend to be accepted by previous subdiagrams.

For example, you create code in the first subdiagram of a Type Specialization structure
for data type A in a malleable VI. When the input data type is A, you expect the Type
Specialization structure to accept the first subdiagram. However, if the code in the first
subdiagram breaks for reasons unrelated to the data type, for example, due to a
broken subVI, the Type Specialization structure declines the first subdiagram and
attempts to compile the remaining subdiagrams in order. A problem that can arise in
this situation is when one of the remaining subdiagrams is also acceptable with data
type A. In this case, the malleable VI is unbroken but may behave in an unexpected
way for data type A.

780 ni.com
Functions

Handling Data Types with Subtypes

For data types with subtypes, such as arrays, clusters, and some refnums, this function
also checks array dimensions and subtypes, but not the subtype names. For example,
the calling VI does not break if the input data type is 1D array of variant and the
specified mismatch data type is 2D array of variant or 1D array of scalars. If the input
data type is a cluster of a string named lecture and an unsigned 8-bit integer named
number of students, while the specified mismatch data type is a cluster of a
string named lecture 1 and an unsigned 8-bit integer named size, the calling VI
breaks because the subtypes of the two clusters are the same even though the subtype
names are different.

Assert Error Cluster Type VI

Breaks the calling VI unless the input data is an error cluster.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for error clusters or to
force a malleable VI to accept error clusters only.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for error clusters or to
force a malleable VI to accept error clusters only.

Inputs/Outputs
• value in —

value in specifies the input data.

• value out —

value out returns the input data if value in is an error cluster. Otherwise, this output returns an
empty error cluster.

© National Instruments 781


Functions

Assert Array Dimension Count VI

Breaks the calling VI unless value in is an array with the same number of dimensions
as array type.

To check if each dimension has the same size, use the Assert Array Dimension Sizes VI.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for certain array types
or to force a malleable VI to accept certain array types only.

Inputs/Outputs
• array type —

array type specifies the input comparison array with the requirements that the input data must
meet.

This input accepts arrays of any data type. To set the data type of this input, wire a constant or
control of the desired data type to array type. LabVIEW ignores any data in the constant or
control wired to array type.

• value in —

value in specifies the input data.

This input accepts arrays that meet the requirements of array type.

• value out —

value out returns the input data if value in is an array that meets the requirements. Otherwise,
this output returns an empty array of array type.

Assert Array Dimension Sizes VI

Breaks the calling VI unless value in is an array with the same number of dimensions

782 ni.com
Functions

as array type and each dimension in value in has the same size requirement (fixed,
bounded, or variable-sized) and size (for fixed and bounded) as the corresponding
dimension in array type.

If you do not need to compare the size of each dimension, use the Assert Array
Dimension Count VI.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for certain array types
or to force a malleable VI to accept certain array types only.

Inputs/Outputs
• array type —

array type specifies the input comparison array with the requirements that the input data must
meet.

This input accepts arrays of any data type. To set the data type of this input, wire a constant or
control of the desired data type to array type. LabVIEW ignores any data in the constant or
control wired to array type.

• value in —

value in specifies the input data.

This input accepts arrays that meet the requirements of array type.

• value out —

value out returns the input data if value in is an array that meets the requirements. Otherwise,
this output returns an empty array of array type.

Assert Same or Descendant Type VI

Breaks the calling VI unless the input data is the same as or is a descendant of the

© National Instruments 783


Functions

input class or interface.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for the specified class
or interface or the descendants of the specified class or interface or to force a
malleable VI to accept the specified class or interface or the descendants of the
specified class or interface only.

Inputs/Outputs
• ancestor type —

ancestor type specifies the input class or interface with the requirements that the input data
must meet.

This input accepts any class or interface. To set the class or interface of this input, wire a
constant or control of the desired class or interface to ancestor type. LabVIEW ignores any data
in the constant or control wired to ancestor type.

• value in —

value in specifies the input data.

This input accepts the class or interface of ancestor type or descendants of ancestor type.

• value out —

value out returns the input data if value in meets the requirements. Otherwise, this output
returns the default value of ancestor type.

Assert Scalar Numeric Or Waveform Type VI

Breaks the calling VI unless the input data is a scalar numeric or analog waveform
type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization

784 ni.com
Functions

structure to customize sections of code in a malleable VI (.vim) for scalar numeric or


waveform types or to force a malleable VI to accept scalar numeric or waveform types
only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any scalar numeric or waveform data type.

• value out —

value out returns the input data if value in is a scalar numeric or analog waveform type.
Otherwise, this output returns a double-precision floating-point number 0.

Assert Scalar Numeric Type VI

Breaks the calling VI unless the input data is a scalar numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for scalar numeric
types or to force a malleable VI to accept scalar numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any scalar numeric data type.

© National Instruments 785


Functions

• value out —

value out returns the input data if value in is a scalar numeric type. Otherwise, this output
returns a double-precision floating-point number 0.

Assert Real Numeric Or Waveform Type VI

Breaks the calling VI unless the input data is a non-complex numeric or analog
waveform type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for non-complex
numeric or waveform types or to force a malleable VI to accept non-complex numeric
or analog waveform types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any non-complex numeric or waveform data type.

• value out —

value out returns the input data if value in is a non-complex numeric or analog waveform type.
Otherwise, this output returns a double-precision floating-point number 0.

Assert Real Numeric Type VI

Breaks the calling VI unless the input data is a non-complex numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for non-complex
numeric types or to force a malleable VI to accept non-complex numeric types only.

786 ni.com
Functions

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any non-complex numeric data type.

• value out —

value out returns the input data if value in is a non-complex numeric type. Otherwise, this
output returns a double-precision floating-point number 0.

Assert Fractional Numeric Type VI

Breaks the calling VI unless the input data is a floating-point, complex floating-point,
or fixed-point numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for floating-point,
complex floating-point, or fixed-point numeric types or to force a malleable VI to
accept floating-point, complex floating-point, or fixed-point numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any floating-point, complex floating-point, or fixed-point numeric data type.

• value out —

© National Instruments 787


Functions

value out returns the input data if value in is a floating-point, complex floating-point, or fixed-
point numeric type. Otherwise, this output returns a double-precision floating-point number 0.

Assert Complex Numeric Type VI

Breaks the calling VI unless the input data is a complex numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for complex numeric
types or to force a malleable VI to accept complex numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any complex numeric data type.

• value out —

value out returns the input data if value in is a complex numeric type. Otherwise, this output
returns a complex double-precision number 0 +0 i.

This output can return any complex numeric type.

Assert Floating-Point Numeric Type VI

Breaks the calling VI unless the input data is a floating-point or complex floating-point
numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for floating-point or
complex floating-point numeric types or to force a malleable VI to accept floating-

788 ni.com
Functions

point or complex floating-point numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any floating-point or complex floating-point numeric data type.

• value out —

value out returns the input data if value in is a floating-point or complex floating-point numeric
type. Otherwise, this output returns a double-precision floating-point number 0.

Assert Real Floating-Point Numeric Type VI

Breaks the calling VI unless the input data is a non-complex floating-point numeric
type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for non-complex
floating-point numeric types or to force a malleable VI to accept non-complex floating-
point numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any non-complex floating-point numeric data type.

© National Instruments 789


Functions

• value out —

value out returns the input data if value in is a non-complex floating-point numeric type.
Otherwise, this output returns a double-precision floating-point number 0.

Assert Integer Type VI

Breaks the calling VI unless the input data is an integer numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for integer numeric
types or to force a malleable VI to accept integer numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any integer numeric data type.

• value out —

value out returns the input data if value in is an integer numeric type. Otherwise, this output
returns a 32-bit signed integer 0.

Assert Signed Integer Type VI

Breaks the calling VI unless the input data is a signed integer numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for signed integer
numeric types or to force a malleable VI to accept signed integer numeric types only.

790 ni.com
Functions

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any signed integer numeric data type.

• value out —

value out returns the input data if value in is a signed integer numeric type. Otherwise, this
output returns a 32-bit signed integer 0.

Assert Unsigned Integer Type VI

Breaks the calling VI unless the input data is an unsigned integer numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for unsigned integer
numeric types or to force a malleable VI to accept unsigned integer numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

This input accepts any unsigned integer numeric data type.

• value out —

value out returns the input data if value in is an unsigned integer numeric type. Otherwise, this
output returns a 32-bit unsigned integer 0.

© National Instruments 791


Functions

Assert Fixed-Point Numeric Type VI

Breaks the calling VI unless the input data is a fixed-point numeric type.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for fixed-point
numeric data types or to force a malleable VI to accept fixed-point numeric types only.

This VI does nothing at run time. Use this VI in conjunction with the Type Specialization
structure to customize sections of code in a malleable VI (.vim) for fixed-point
numeric data types or to force a malleable VI to accept fixed-point numeric types only.

Inputs/Outputs
• value in —

value in specifies the input data.

• value out —

value out returns the input data if value in is a fixed-point numeric type. Otherwise, this output
returns a fixed-point number 0.

Is Value Changed

Returns TRUE if this is the first call of this VI or if the input value is different from the
value when this VI was last called.

Inputs/Outputs
• value —

792 ni.com
Functions

value specifies the value to check. This input accepts any data type.

• changed or first call? —

changed or first call? returns TRUE if this is the first call of this VI or if the value changed since
the last time this VI was called. Otherwise, this output returns FALSE.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Malleable VIs\Basics\Malleable VIs


Basics.lvproj

Is Path and Not Empty?

Returns TRUE if path is any value other than <Not A Path> or an empty path.
Otherwise, this VI returns FALSE.

Inputs/Outputs
• path —

path specifies the path you want to check.

• Is Path and Not Empty? —

Is Path and Not Empty? returns TRUE if path is any value other than <Not A Path> or an
empty path. Otherwise, Is Path and Not Empty? returns FALSE.

Fixed-Point Overflow? Function

Returns TRUE if FXP includes an overflow status and FXP is the result of an operation
that overflowed. Otherwise, this function returns FALSE.

© National Instruments 793


Functions

Inputs/Outputs
• FXP —

FXP specifies a fixed-point number.

• overflow? —

overflow? is TRUE if FXP includes an overflow status and FXP is the result of an operation that
overflowed.

If FXP does not include an overflow status, or if FXP includes an overflow status but is not the
result of an operation that overflowed, overflow? is FALSE.

Waveform
Use the Waveform VIs and functions to build waveforms that include the waveform
values, channel information, and timing information, and to set and retrieve waveform
attributes and components.

The VIs and functions on this palette can return waveform error codes.

Palette
Description
Object
Get
Returns the analog waveform you specify. You specify components by clicking on the
Waveform
center of the output terminal and selecting the component you want.
Components
Builds an analog waveform or modifies an existing waveform. If you do not wire the
Build waveform input, the function creates a new waveform based on the components
Waveform you wire. If you wire the waveform input, the function modifies the waveform based
on the components you wire.
Set Adds or replaces a waveform attribute. You can use any type of data for the value of

794 ni.com
Functions

Palette
Description
Object
Waveform
Attribute the attribute.
Function
Get
Waveform Retrieves the names and values of all attributes or the value of a single attribute,
Attribute depending on whether you wire the name parameter.
Function

Analog to Converts analog waveform to a digital waveform or digital data. You must manually
Digital select the polymorphic instance you want to use.

Digital to Converts a digital waveform or digital data to analog waveform. You must manually
Analog select the polymorphic instance you want to use.

Selects one waveform out of an array of analog or digital waveforms by array index
Index
or channel name. The data types you wire to the waveform array and index inputs
Waveform
and the data type of the Y component of the analog waveform determine the
Array
polymorphic instance to use.

Replaces all dt values with the dt value of the waveform at index position in
Copy waveforms in. The data type you wire to the waveforms in input and the data type of
Waveform dt the Y component of the analog waveform determine the polymorphic instance to
use.

Replaces all the time stamp values (t0) in waveforms in with the value of the index
Align
element in the array. The data type you wire to the waveforms in input and the data
Waveform
type of the Y component of the analog waveform determine the polymorphic
Timestamps
instance to use.

Get
Retrieves a subset of a waveform at a specified time or index. You must manually
Waveform
select the polymorphic instance you want to use.
Subset

© National Instruments 795


Functions

Palette
Description
Object

Returns the ending time value of waveform in. The formula used is xf = x0 + duration
Get Final
of waveform in. Wire data to the waveform in input to determine the polymorphic
Time Value
instance to use or manually select the instance.

Computes the duration of waveform in using the following equation: duration =


Waveform
(#samples-1) × dx. Wire data to the waveform in input to determine the polymorphic
Duration
instance to use or manually select the instance.

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
Scale Delta t
you wire to the waveform in input and the data type of the Y component of the
analog waveform determine the polymorphic instance to use.

Returns the X and Y value of a waveform or digital data set. The data type you wire to
Get XY Value the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

Get Creates an array of waveform time stamps. Each element in the array is the time
Waveform stamp for each data value in the waveform. Wire data to the waveform in input to
Time Array determine the polymorphic instance to use or manually select the instance.

Analog Use the Analog Waveform VIs and functions to perform arithmetic and comparison
Waveform functions on waveforms.

Digital Use the Digital Waveform VIs and functions to perform operations on digital
Waveform waveforms and digital data.

Waveform Use the Waveform File I/O VIs to write waveform data to and read waveform data
File I/O from files.

796 ni.com
Functions

Get Waveform Components

Returns the analog waveform you specify. You specify components by clicking on the
center of the output terminal and selecting the component you want.

Inputs/Outputs
• waveform —

waveform is the waveform from which you want to retrieve components.

• t0 —

t0 returns the trigger time of the waveform.

• dt —

dt returns the time interval in seconds between data points in the waveform.

• Y—

Y returns the data values of the waveform.

• attributes —

attributes returns the names and values of all waveform attributes.

You also can use the Get Waveform Attribute VI to retrieve the names and values of all attributes
or the value of a single attribute.

Build Waveform

Builds an analog waveform or modifies an existing waveform. If you do not wire the
waveform input, the function creates a new waveform based on the components you
wire. If you wire the waveform input, the function modifies the waveform based on the
components you wire.

© National Instruments 797


Functions

Inputs/Outputs
• waveform —

waveform is the analog waveform you want to edit. If you do not wire an existing waveform, the
function creates a new waveform based on the components you wire.

• t0 —

t0 specifies the start time of the waveform.

• dt —

dt specifies the time interval in seconds between data points in the waveform.

• Y—

Y specifies the data values of the waveform.

• attributes —

attributes sets the names and values of all waveform attributes.

You also can use the Set Waveform Attribute function to set the name and value of a single
attribute.

• output waveform —

waveform is the resulting waveform. If you did not wire an existing waveform, this is a new
waveform. If you wired an existing waveform, this is the edited waveform.

Set Waveform Attribute Function

Adds or replaces a waveform attribute. You can use any type of data for the value of
the attribute.

798 ni.com
Functions

Inputs/Outputs
• waveform —

waveform is the waveform for which you want to add or replace an attribute.

• name —

name is the name of the attribute.

• value —

value is the value of the attribute. This input is polymorphic, so you can wire any data to it.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform with the new or replaced attribute.

• replaced —

replaced indicates if an attribute was overwritten.

• error out —

error out contains error information. This output provides standard error out functionality.

If the attribute in name already exists, the function overwrites the attribute with the
new value, and replaced is TRUE. If the attribute in name does not exist already, the
function creates a new attribute. Some attributes are set by NI-DAQ and Express VIs.

The following table lists the waveform attributes set by NI-DAQ.

Name Attribute Data Acceptable Values Description

© National Instruments 799


Functions

Type
Hardware Any value is NI_DeviceNumber is the device
Device NI_DeviceNumber String acceptable for number of the hardware producing
Number NI_DeviceNumber. the waveform.
Any value is NI_ChannelName is the name of the
Name of
NI_ChannelName String acceptable for virtual channel producing the
Channel
NI_ChannelName. waveform.
NI_LineNames is the name of the
Name of Any value is digital line in the waveform. For more
Digital NI_LineNames String acceptable for than one digital line, the function
Line(s) NI_LineNames. returns the line names in reverse
order.
Volts, PSI, and so
forth are
Unit for NI_UnitDescription is the units of
NI_UnitDescription String acceptable values
Data measure for the waveform.
for
NI_UnitDescription.

The following table lists the waveform attributes set by Express VIs.

Data
Name Attribute Acceptable Values Description
Type
NI_ExpStartTimeStamp is
the time stamp of the first
sample in the first
waveform. In Express VIs,
this is set once per start
of the VI and does not
change, even if waveform
Any value is acceptable data is generated in a
Start Time
NI_ExpStartTimeStamp for loop. In Express VIs,
Timestamp stamp
NI_ExpStartTimeStamp. NI_ExpStartTimeStamp is
set according to the PC
clock unless the
waveform originates in
NI-DAQ. When the
waveform originates in
NI-DAQ, NI-DAQ sets
NI_ExpStartTimeStamp.

800 ni.com
Functions

NI_ExpTimeStamp is the
time stamp of the first
sample in the waveform.
In Express VIs,
NI_ExpTimeStamp is set
Time Any value is acceptable according to the PC clock
Timestamp NI_ExpTimeStamp
stamp for NI_ExpTimeStamp. unless the waveform
originates in NI-DAQ.
When the waveform
originates in NI-DAQ, NI-
DAQ sets
NI_ExpTimeStamp.
If the value of
Use a single character
NI_ExpXDimension is t, t0
for the
and dt are unchanged. If
NI_ExpXDimension
the value of
value. Currently, only t
X NI_ExpXDimension is f,
NI_ExpXDimension String for time and f for
Dimension Express VIs interpret t0
frequency are
and dt as f0 and df. For all
supported. The value
other values, or unknown
for NI_ExpXDimension
dimension, t0 and dt are
is case sensitive.
interpreted as X0 and dX.
If and only if
TRUE or FALSE are NI_ExpXDimension is t,
Relative
NI_ExpIsRelativeTime Boolean acceptable values for Express VIs set t0 as a
Time?
NI_ExpIsRelativeTime. relative/absolute time
stamp value.

Note Express VIs also use the attributes set by NI-DAQ. If the waveform does
not originate in NI-DAQ, Express VIs add NI_ChannelName.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Create.vi

© National Instruments 801


Functions

Get Waveform Attribute Function

Retrieves the names and values of all attributes or the value of a single attribute,
depending on whether you wire the name parameter.

Attributes can be channel names. The connector pane displays the default data types
for this polymorphic function.

Inputs/Outputs
• waveform —

waveform is the waveform for which you want to retrieve an attribute(s) and value(s).

• name —

name is the name of the attribute whose value you want to retrieve.

Do not wire this parameter if you want to retrieve all the attributes associated with the specified
waveform. If you wire name, the names output changes to a Boolean output found, the array
output values changes to an output called value of the same type as default value, and the
function searches for only the specified attribute.
• default value (empty Variant) —

default value is a value and data type that you specify. If the function does not find the attribute
specified in name, it returns the default value.

If you wire default value, you must wire name.


• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• duplicate waveform —

duplicate waveform is the waveform data you input in waveform.

• names —

802 ni.com
Functions

names returns a 1D array containing the names of all attributes associated with the waveform.

If you wire the name parameter, this output changes to a Boolean value found. found returns
TRUE if the function finds the attribute that you specify in name.
• values —

values returns a 1D array containing the values associated with each attribute of the specified
waveform in variant format.

You must unflatten each attribute value to an appropriate data type. If you wire name, this
output changes to a single variant value. If the function does not find the attribute that you
specify in name, it returns the value passed to default value.
• error out —

error out contains error information. This output provides standard error out functionality.

This function has two modes of behavior depending on whether you wire the name
parameter. By default, the function returns the names of all attributes and their
corresponding values in 1D arrays. If you wire name, the names output changes to a
Boolean output found, the values output changes to a variant output value, and the
function searches for only the specified attribute. If the function does not find the
specified attribute(s), or if it cannot convert the attribute(s) to the default value, found
is FALSE, and value displays the contents of default value.

The following table lists the waveform attributes set by NI-DAQ.

Data
Name Attribute Acceptable Values Description
Type
Hardware NI_DeviceNumber is the device
Any value is acceptable
Device NI_DeviceNumber String number of the hardware device
for NI_DeviceNumber.
Number producing the waveform.
NI_ChannelName is the name of
Name of Any value is acceptable
NI_ChannelName String the virtual channel producing
Channel for NI_ChannelName.
the waveform.
Name of
Any value is acceptable NI_LineNames is the name of
Digital NI_LineNames String
for NI_LineNames. the digital line in the waveform.
Line(s)

© National Instruments 803


Functions

Data
Name Attribute Acceptable Values Description
Type
Volts, PSI, and so forth
Unit for NI_UnitDescription is the units
NI_UnitDescription String are acceptable values for
Data of measure for the waveform.
NI_UnitDescription.

The following table lists the waveform attributes set by Express VIs.

Data
Name Attribute Acceptable Values Description
Type
NI_ExpStartTimeStamp is
the time stamp of the first
sample in the first
waveform. In Express VIs,
this is set once per start
of the VI and does not
change, even if waveform
Any value is acceptable data is generated in a
Start Time
NI_ExpStartTimeStamp for loop. In Express VIs,
Timestamp stamp
NI_ExpStartTimeStamp. NI_ExpStartTimeStamp is
set according to the PC
clock unless the
waveform originates in
NI-DAQ. When the
waveform originates in
NI-DAQ, NI-DAQ sets
NI_ExpStartTimeStamp.
NI_ExpTimeStamp is the
time stamp of the first
sample in the waveform.
In Express VIs,
NI_ExpTimeStamp is set
Time Any value is acceptable according to the PC clock
Timestamp NI_ExpTimeStamp
stamp for NI_ExpTimeStamp. unless the waveform
originates in NI-DAQ.
When the waveform
originates in NI-DAQ, NI-
DAQ sets
NI_ExpTimeStamp.

804 ni.com
Functions

Data
Name Attribute Acceptable Values Description
Type
If the value of
NI_ExpXDimension is t, t0
Use a single character
and dt are unchanged. If
for the
the value of
NI_ExpXDimension
NI_ExpXDimension is f,
value. Currently, only t
X Express VIs interpret t0
NI_ExpXDimension String for time and f for
Dimension and dt as f0 and df. For all
frequency are
other values, Express VIs
supported. The value
generically interpret t0
for NI_ExpXDimension
and dt as X0 and dX, but
is case sensitive.
there is no effect
otherwise.
If and only if
TRUE or FALSE are NI_ExpXDimension is t,
Relative
NI_ExpIsRelativeTime Boolean acceptable values for Express VIs set t0 as a
Time?
NI_ExpIsRelativeTime. relative/absolute time
stamp value.

Note Express VIs also use the attributes set by NI-DAQ. If the waveform does
not originate in NI-DAQ, Express VIs add NI_ChannelName.

Analog to Digital

Converts analog waveform to a digital waveform or digital data. You must manually
select the polymorphic instance you want to use.

• DWDT Analog to Digital VI


• DTbl Analog to Digital VI

To create digital data from an analog waveform or to graph an analog signal in a digital
waveform graph, you must convert the raw analog data into digital data or the digital
waveform data type. Use the Analog to Digital VI to convert the data to digital
waveform. Use the Get Waveform Components function to extract the digital data from

© National Instruments 805


Functions

the digital waveform.

The block diagram below simulates the acquisition of a sine wave with an amplitude of
5, which means the sine wave can contain values that range from –5 to 5. The Analog to
Digital VI in this block diagram represents each value with 8 bits. The 8 bits can
represent a peak-to-peak value of 10. The probe displays a portion of the resulting
values in binary format.

DWDT Analog to Digital VI

Converts analog waveform to a digital waveform or digital data. You must manually
select the polymorphic instance you want to use.

806 ni.com
Functions

Inputs/Outputs
• compress digital (T) —

compress digital specifies whether to compress the digital waveform or digital data. The default
is TRUE.

• analog waveform —

analog waveform is the waveform you want to convert to digital waveform or digital data.

• resolution (16 bit) —

resolution specifies the number of bits represented in the digital waveform or digital data.

• full-scale range (pk-pk) —

full-scale range (pk-pk) specifies the total peak-to-peak range, or the difference between the
minimum and maximum, for the digital waveform or digital data. For example, if the maximum
range of a waveform is 1 and the minimum is –1, the full-scale range for the waveform is 2. The
default is 2.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

If an error occurred before this node runs, this node outputs an empty waveform.

• data format (offset binary) —

data format specifies which binary representation you want to use for the digital waveform or
digital data.

0 unsigned binary—Converts the data to unsigned binary.


offset binary (default)—The largest negative full-scale value is represented by all zeros, and the
1 largest positive full-scale value is represented by all ones. Zero-scale is represented by a one
(MSB) followed by all zeros, for example, binary 1000.
2's complement—Uses two's complement format, which is a common format for representing
2
signed binary values. This format is similar to offset binary, but the MSB is inverted.

• digital waveform —

© National Instruments 807


Functions

digital waveform returns the waveform that results from the conversion of analog waveform.

• resolution (out) —

resolution (out) returns the number of bits represented in the digital waveform or digital data.

• full-scale range (out) —

full-scale range (out) returns the total peak-to-peak range for the digital waveform or digital
data.

• error out —

error out contains error information. This output provides standard error out functionality.

To create digital data from an analog waveform or to graph an analog signal in a digital
waveform graph, you must convert the raw analog data into digital data or the digital
waveform data type. Use the Analog to Digital VI to convert the data to digital
waveform. Use the Get Waveform Components function to extract the digital data from
the digital waveform.

The block diagram below simulates the acquisition of a sine wave with an amplitude of
5, which means the sine wave can contain values that range from –5 to 5. The Analog to
Digital VI in this block diagram represents each value with 8 bits. The 8 bits can
represent a peak-to-peak value of 10. The probe displays a portion of the resulting
values in binary format.

808 ni.com
Functions

DTbl Analog to Digital VI

Converts analog waveform to a digital waveform or digital data. You must manually
select the polymorphic instance you want to use.

Inputs/Outputs
• compress digital (T) —

compress digital specifies whether to compress the digital waveform or digital data. The default
is TRUE.

• analog waveform —

analog waveform is the waveform you want to convert to digital waveform or digital data.

© National Instruments 809


Functions

• resolution (16 bit) —

resolution specifies the number of bits represented in the digital waveform or digital data.

• full scale range (pk-pk) —

full-scale range (pk-pk) specifies the total peak-to-peak range, or the difference between the
minimum and maximum, for the digital waveform or digital data. For example, if the maximum
range of a waveform is 1 and the minimum is –1, the full-scale range for the waveform is 2. The
default is 2.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

If an error occurred before this node runs, this node outputs an empty waveform.

• data format (offset binary) —

data format specifies which binary representation you want to use for the digital waveform or
digital data.

0 unsigned binary—Converts the data to unsigned binary.


offset binary (default)—The largest negative full-scale value is represented by all zeros, and the
1 largest positive full-scale value is represented by all ones. Zero-scale is represented by a one
(MSB) followed by all zeros, for example, binary 1000.
2's complement—Uses two's complement format, which is a common format for representing
2
signed binary values. This format is similar to offset binary, but the MSB is inverted.

• digital data —

digital data returns the data resulting from the conversion of analog waveform.

• resolution (out) —

resolution (out) returns the number of bits represented in the digital waveform or digital data.

• full-scale range (out) —

full-scale range (out) returns the total peak-to-peak range for the digital waveform or digital
data.

• error out —

810 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

To create digital data from an analog waveform or to graph an analog signal in a digital
waveform graph, you must convert the raw analog data into digital data or the digital
waveform data type. Use the Analog to Digital VI to convert the data to digital
waveform. Use the Get Waveform Components function to extract the digital data from
the digital waveform.

The block diagram below simulates the acquisition of a sine wave with an amplitude of
5, which means the sine wave can contain values that range from –5 to 5. The Analog to
Digital VI in this block diagram represents each value with 8 bits. The 8 bits can
represent a peak-to-peak value of 10. The probe displays a portion of the resulting
values in binary format.

Digital to Analog

Converts a digital waveform or digital data to analog waveform. You must manually
select the polymorphic instance you want to use.

© National Instruments 811


Functions

• DWDT Digital to Analog VI


• DTbl Digital to Analog VI

DWDT Digital to Analog VI

Converts a digital waveform or digital data to analog waveform. You must manually
select the polymorphic instance you want to use.

Inputs/Outputs
• digital waveform —

digital waveform is the waveform you want to convert to analog waveform.

• full-scale range (pk-pk) —

full-scale range (pk-pk) specifies the total peak-to-peak range, or the difference between the
minimum and maximum, for the digital waveform or digital data. For example, if the maximum
range of a waveform is 1 and the minimum is –1, the full-scale range for the waveform is 2. The
default is 2.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

If an error occurred before this node runs, this node outputs an empty waveform.

• data format (offset binary) —

data format specifies which binary representation you want to use for the digital waveform or
digital data.

812 ni.com
Functions

0 unsigned binary—Converts the data to unsigned binary.


offset binary (default)—The largest negative full-scale value is represented by all zeros, and the
1 largest positive full-scale value is represented by all ones. Zero-scale is represented by a one
(MSB) followed by all zeros, for example, binary 1000.
2's complement—Uses two's complement format, which is a common format for representing
2
signed binary values. This format is similar to offset binary, but the MSB is inverted.

• analog waveform —

analog waveform returns the waveform resulting from the conversion of digital waveform or
digital table.

• resolution (out) —

resolution (out) returns the number of bits represented in the digital waveform or digital data.

• full-scale range (out) —

full-scale range (out) returns the total peak-to-peak range for the digital waveform or digital
data.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Digital to Analog VI

Converts a digital waveform or digital data to analog waveform. You must manually
select the polymorphic instance you want to use.

Inputs/Outputs
• digital table —

digital table is the digital data you want to convert to analog waveform.

© National Instruments 813


Functions

• full-scale range (pk-pk) —

full-scale range (pk-pk) specifies the total peak-to-peak range, or the difference between the
minimum and maximum, for the digital waveform or digital data. For example, if the maximum
range of a waveform is 1 and the minimum is –1, the full-scale range for the waveform is 2. The
default is 2.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

If an error occurred before this node runs, this node outputs an empty waveform.

• data format (offset binary) —

data format specifies which binary representation you want to use for the digital waveform or
digital data.

0 unsigned binary—Converts the data to unsigned binary.


offset binary (default)—The largest negative full-scale value is represented by all zeros, and the
1 largest positive full-scale value is represented by all ones. Zero-scale is represented by a one
(MSB) followed by all zeros, for example, binary 1000.
2's complement—Uses two's complement format, which is a common format for representing
2
signed binary values. This format is similar to offset binary, but the MSB is inverted.

• analog waveform —

analog waveform returns the waveform resulting from the conversion of digital waveform or
digital table.

• resolution (out) —

resolution (out) returns the number of bits represented in the digital waveform or digital data.

• full-scale range (out) —

full-scale range (out) returns the total peak-to-peak range for the digital waveform or digital
data.

• error out —

error out contains error information. This output provides standard error out functionality.

814 ni.com
Functions

Index Waveform Array

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

• WDT Index Channel DBL VI


• WDT Index Channel I64 VI
• WDT Index Channel I32 VI
• WDT Index Channel I16 VI
• WDT Index Channel CDB VI
• WDT Index Channel by Name DBL VI
• WDT Index Channel by Name I64 VI
• WDT Index Channel by Name I32 VI
• WDT Index Channel by Name I16 VI
• WDT Index Channel by Name CDB VI
• DWDT Index Channel VI
• DWDT Index Channel by Name VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel DBL VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

© National Instruments 815


Functions

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• index —

index is the index of the waveform to extract from waveform array.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel I64 VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

816 ni.com
Functions

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• index —

index is the index of the waveform to extract from waveform array.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel I32 VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

© National Instruments 817


Functions

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• index —

index is the index of the waveform to extract from waveform array.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel I16 VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

818 ni.com
Functions

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• index —

index is the index of the waveform to extract from waveform array.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel CDB VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

© National Instruments 819


Functions

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• index —

index is the index of the waveform to extract from waveform array.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel by Name DBL VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

820 ni.com
Functions

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• channel name —

channel name is the channel name of the waveform to extract from waveform array.

To use this input, the waveform must have a channel name attribute. If you are using a virtual
channel, you do not have to set the channel name attribute manually.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel by Name I64 VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

© National Instruments 821


Functions

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• channel name —

channel name is the channel name of the waveform to extract from waveform array.

To use this input, the waveform must have a channel name attribute. If you are using a virtual
channel, you do not have to set the channel name attribute manually.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel by Name I32 VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic

822 ni.com
Functions

instance to use.

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• channel name —

channel name is the channel name of the waveform to extract from waveform array.

To use this input, the waveform must have a channel name attribute. If you are using a virtual
channel, you do not have to set the channel name attribute manually.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

WDT Index Channel by Name I16 VI

Selects one waveform out of an array of analog or digital waveforms by array index or

© National Instruments 823


Functions

channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• channel name —

channel name is the channel name of the waveform to extract from waveform array.

To use this input, the waveform must have a channel name attribute. If you are using a virtual
channel, you do not have to set the channel name attribute manually.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

824 ni.com
Functions

WDT Index Channel by Name CDB VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

Inputs/Outputs
• waveform array —

waveform array is an array of analog waveforms from which to extract a single waveform.

• channel name —

channel name is the channel name of the waveform to extract from waveform array.

To use this input, the waveform must have a channel name attribute. If you are using a virtual
channel, you do not have to set the channel name attribute manually.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the analog waveform selected from the array of waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 825


Functions

• labview\examples\Waveform\Waveform - Index Array.vi

DWDT Index Channel VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

Inputs/Outputs
• waveform array —

waveform array is an array of digital waveforms from which to extract a single digital waveform.

• index —

index is the index of the waveform to extract from waveform array.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the digital waveform selected from the array of digital waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Index Array.vi

826 ni.com
Functions

DWDT Index Channel by Name VI

Selects one waveform out of an array of analog or digital waveforms by array index or
channel name. The data types you wire to the waveform array and index inputs and
the data type of the Y component of the analog waveform determine the polymorphic
instance to use.

Inputs/Outputs
• waveform array —

waveform array is an array of digital waveforms from which to extract a single digital waveform.

• channel name —

channel name is the channel name of the waveform to extract from waveform array.

To use this input, the waveform must have a channel name attribute. If you are using a virtual
channel, you do not have to set the channel name attribute manually.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform —

waveform is the digital waveform selected from the array of digital waveforms.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 827


Functions

• labview\examples\Waveform\Waveform - Index Array.vi

Copy Waveform dt

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

• WDT Copy Waveform dt DBL VI


• WDT Copy Waveform dt I64 VI
• WDT Copy Waveform dt I32 VI
• WDT Copy Waveform dt I16 VI
• WDT Copy Waveform dt CDB VI
• WDT Copy Waveform dt EXT VI
• WDT Copy Waveform dt CXT VI
• DWDT Copy Waveform dt VI

WDT Copy Waveform dt DBL VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveforms in —

waveforms in contains the analog waveforms for which the time increment values are replaced
by the time increment of the analog waveform indicated by index. The default is empty.

• index —

828 ni.com
Functions

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains analog waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Copy Waveform dt I64 VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveforms in —

waveforms in contains the analog waveforms for which the time increment values are replaced
by the time increment of the analog waveform indicated by index. The default is empty.

• index —

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

© National Instruments 829


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains analog waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Copy Waveform dt I32 VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveforms in —

waveforms in contains the analog waveforms for which the time increment values are replaced
by the time increment of the analog waveform indicated by index. The default is empty.

• index —

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

830 ni.com
Functions

waveforms out contains analog waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Copy Waveform dt I16 VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveforms in —

waveforms in contains the analog waveforms for which the time increment values are replaced
by the time increment of the analog waveform indicated by index. The default is empty.

• index —

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains analog waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 831


Functions

WDT Copy Waveform dt CDB VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveforms in —

waveforms in contains the analog waveforms for which the time increment values are replaced
by the time increment of the analog waveform indicated by index. The default is empty.

• index —

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains analog waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Copy Waveform dt EXT VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

832 ni.com
Functions

Inputs/Outputs
• waveforms in —

waveforms in contains the analog waveforms for which the time increment values are replaced
by the time increment of the analog waveform indicated by index. The default is empty.

• index —

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains analog waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Copy Waveform dt CXT VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

© National Instruments 833


Functions

Inputs/Outputs
• waveforms in —

waveforms in contains the analog waveforms for which the time increment values are replaced
by the time increment of the analog waveform indicated by index. The default is empty.

• index —

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains analog waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

DWDT Copy Waveform dt VI

Replaces all dt values with the dt value of the waveform at index position in
waveforms in. The data type you wire to the waveforms in input and the data type of
the Y component of the analog waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveforms in —

waveforms in contains the digital waveforms for which the time increment values are replaced
by the time increment of the digital waveform indicated by index. The default is empty.

834 ni.com
Functions

• index —

index is the specifier that the waveform in the waveforms in array uses for the dt value. The
default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains digital waveforms for which the dt values are all identical.

• error out —

error out contains error information. This output provides standard error out functionality.

Align Waveform Timestamps

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

• WDT Align Waveform Timestamps DBL VI


• WDT Align Waveform Timestamps I64 VI
• WDT Align Waveform Timestamps I32 VI
• WDT Align Waveform Timestamps I16 VI
• WDT Align Waveform Timestamps CDB VI
• WDT Align Waveform Timestamps EXT VI
• WDT Align Waveform Timestamps CXT VI
• DWDT Align Waveform Timestamps VI

© National Instruments 835


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

WDT Align Waveform Timestamps DBL VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the analog waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

836 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

WDT Align Waveform Timestamps I64 VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the analog waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 837


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

WDT Align Waveform Timestamps I32 VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the analog waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

838 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

WDT Align Waveform Timestamps I16 VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the analog waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 839


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

WDT Align Waveform Timestamps CDB VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the analog waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

840 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

WDT Align Waveform Timestamps EXT VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the analog waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 841


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

WDT Align Waveform Timestamps CXT VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the analog waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

842 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

DWDT Align Waveform Timestamps VI

Replaces all the time stamp values (t0) in waveforms in with the value of the index
element in the array. The data type you wire to the waveforms in input and the data
type of the Y component of the analog waveform determine the polymorphic instance
to use.

Inputs/Outputs
• waveforms in —

waveforms in contains all the digital waveforms for which time stamps (t0) are to be changed.

• index —

index selects which waveform to extract the time stamp from. The time stamps of all elements of
waveforms in are changed to this time stamp.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveforms out —

waveforms out contains the waveforms in array with all time stamps on the elements changed
to the time stamp of the element indicated by index.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 843


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Align Timestamps.vi

Get Waveform Subset

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

• WDT Get Waveform Subset DBL VI


• WDT Get Waveform Subset CDB VI
• WDT Get Waveform Subset EXT VI
• WDT Get Waveform Subset I16 VI
• WDT Get Waveform Subset I32 VI
• WDT Get Waveform Subset I8 VI
• WDT Get Waveform Subset SGL VI
• DWDT Get Waveform Subset VI
• DTbl Digital Subset VI

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

844 ni.com
Functions

WDT Get Waveform Subset DBL VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

© National Instruments 845


Functions

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

WDT Get Waveform Subset CDB VI

Retrieves a subset of a waveform at a specified time or index. You must manually

846 ni.com
Functions

select the polymorphic instance you want to use.

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

© National Instruments 847


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

WDT Get Waveform Subset EXT VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

848 ni.com
Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 849


Functions

standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

WDT Get Waveform Subset I16 VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

850 ni.com
Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 851


Functions

standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

WDT Get Waveform Subset I32 VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

852 ni.com
Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 853


Functions

standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

WDT Get Waveform Subset I8 VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

854 ni.com
Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 855


Functions

standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

WDT Get Waveform Subset SGL VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

856 ni.com
Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 857


Functions

standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

DWDT Get Waveform Subset VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

858 ni.com
Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines whether the waveform subset extracted is an open or closed interval. The
default is TRUE, which selects an open interval.

For example, if t0 = 0, dt = 1, Y = {0, 1, 2}, start/duration format is Relative Time, start samples/
time is 0, and duration is 2, an open interval returns {0, 1}. A closed interval returns {0, 1, 2}.

• start/duration format —

start/duration format specifies if you want to retrieve the data value of the specified element or
at a specified time.

0 Samples (default)—Returns the data value of the specified element in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1 waveform. In this mode, the dt of the waveform affects actual start samples/time and actual
duration.

• waveform in —

waveform in is the digital waveform for which you want to retrieve a subset.

• start samples/time —

start samples/time is the data element or time value where you want to start acquiring a
waveform subset.

• duration —

duration is the amount of time to retrieve data or the number of elements of data you want to
retrieve, depending on the start/duration format you select.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 859


Functions

standard error in functionality.

• waveform out —

waveform out is the waveform subset.

• actual start samples/time —

actual start samples/time is the actual data element when the subset was acquired.

• actual duration —

actual duration is the actual number of elements retrieved or the actual amount of time the
data values were acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

DTbl Digital Subset VI

Retrieves a subset of a waveform at a specified time or index. You must manually


select the polymorphic instance you want to use.

860 ni.com
Functions

Inputs/Outputs
• digital data —

digital data is the set of digital data for which you want to retrieve a subset.

• start —

start is the data element or time value where you want to start acquiring a data subset.

• number of samples —

number of samples specifies the number of samples to include in digital data subset.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital data subset —

digital data subset is the digital data subset.

• error out —

error out contains error information. This output provides standard error out functionality.

For example, consider a waveform of 128 scans with a dt of 1.00. If you wire 40.00 to
duration and 25.00 to start samples/time, the actual duration and actual start
samples/time are the same, 40.00 and 25.00, respectively. However, if the waveform
has a dt of 2.00, the actual duration and the actual start samples/time are 40.00 and
24.00, respectively.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Subset.vi

© National Instruments 861


Functions

Get Final Time Value

Returns the ending time value of waveform in. The formula used is xf = x0 + duration of
waveform in. Wire data to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

• WDT Get Final Time Value DBL VI


• DWDT Get Final Time Value VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Final Time and


Duration.vi

WDT Get Final Time Value DBL VI

Returns the ending time value of waveform in. The formula used is xf = x0 + duration of
waveform in. Wire data to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• open interval? (T) —

open interval? defines the interval over which the input waveform extends. The default is TRUE,
which selects an open interval.

For example, assume an input waveform contains 3 data elements at t = {0, dt, 2dt}. An open

862 ni.com
Functions

interval defines the waveform as extending over the time interval 0 ≤ t < 2dt, and a closed
interval defines the waveform as extending over the time interval 0 ≤ t < 3dt.

• waveform in —

waveform in is the analog waveform for which you want to retrieve the final time value.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• tf —

tf is the time value when the final data value was acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Final Time and


Duration.vi

DWDT Get Final Time Value VI

Returns the ending time value of waveform in. The formula used is xf = x0 + duration of
waveform in. Wire data to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

© National Instruments 863


Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines the interval over which the input waveform extends. The default is TRUE,
which selects an open interval.

For example, assume an input waveform contains 3 data elements at t = {0, dt, 2dt}. An open
interval defines the waveform as extending over the time interval 0 ≤ t < 2dt, and a closed
interval defines the waveform as extending over the time interval 0 ≤ t < 3dt.

• waveform in —

waveform in is the digital waveform for which you want to retrieve the final time value.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• tf —

tf is the time value when the final data value was acquired.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Final Time and


Duration.vi

864 ni.com
Functions

Waveform Duration

Computes the duration of waveform in using the following equation: duration =


(#samples-1) × dx. Wire data to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

• WDT Waveform Duration DBL VI


• DWDT Waveform Duration VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Final Time and


Duration.vi

WDT Waveform Duration DBL VI

Computes the duration of waveform in using the following equation: duration =


(#samples-1) × dx. Wire data to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• open interval? (T) —

open interval? defines the interval over which the input waveform extends. The default is TRUE,
which selects an open interval.

For example, assume an input waveform contains 3 data elements at t = {0, dt, 2dt}. An open

© National Instruments 865


Functions

interval defines the waveform as extending over the time interval 0 ≤ t < 2dt, and a closed
interval defines the waveform as extending over the time interval 0 ≤ t < 3dt.

• waveform in —

waveform in is the analog waveform for which you want the duration.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• duration —

duration is the duration of the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Final Time and


Duration.vi

DWDT Waveform Duration VI

Computes the duration of waveform in using the following equation: duration =


(#samples-1) x dx. Wire data to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

866 ni.com
Functions

Inputs/Outputs
• open interval? (T) —

open interval? defines the interval over which the input waveform extends. The default is TRUE,
which selects an open interval.

For example, assume an input waveform contains 3 data elements at t = {0, dt, 2dt}. An open
interval defines the waveform as extending over the time interval 0 ≤ t < 2dt, and a closed
interval defines the waveform as extending over the time interval 0 ≤ t < 3dt.

• waveform in —

waveform in is the digital waveform for which you want the duration.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• duration —

duration is the duration of the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Final Time and


Duration.vi

© National Instruments 867


Functions

Scale Delta t

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

• WDT Scale Delta t DBL VI


• WDT Scale Delta t SGL VI
• WDT Scale Delta t I64 VI
• WDT Scale Delta t I32 VI
• WDT Scale Delta t I16 VI
• WDT Scale Delta t CDB VI
• WDT Scale Delta t EXT VI
• DWDT Scale Delta t VI

WDT Scale Delta t DBL VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

868 ni.com
Functions

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns the resulting waveform with the new delta t value.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Scale Delta t SGL VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

© National Instruments 869


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns the resulting waveform with the new delta t value.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Scale Delta t I64 VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

870 ni.com
Functions

waveform out returns the resulting waveform with the new delta t value.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Scale Delta t I32 VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns the resulting waveform with the new delta t value.

• error out —

© National Instruments 871


Functions

error out contains error information. This output provides standard error out functionality.

WDT Scale Delta t I16 VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns the resulting waveform with the new delta t value.

• error out —

error out contains error information. This output provides standard error out functionality.

872 ni.com
Functions

WDT Scale Delta t CDB VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns the resulting waveform with the new delta t value.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Scale Delta t EXT VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog

© National Instruments 873


Functions

waveform determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns the resulting waveform with the new delta t value.

• error out —

error out contains error information. This output provides standard error out functionality.

DWDT Scale Delta t VI

Multiplies the delta t component of the waveform by the specified scale factor.
Generally, this lengthens or shortens the sample rate of the waveform. The data type
you wire to the waveform in input and the data type of the Y component of the analog
waveform determine the polymorphic instance to use.

874 ni.com
Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to scale the delta t. The default is empty.

• scale factor —

scale factor is the number by which you multiply the waveform's delta t. A value of greater than
zero but less than 1 shortens the sample rate. A value of greater than 1 increases the sample rate.
The default is 1000.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns the resulting waveform with the new delta t value.

• error out —

error out contains error information. This output provides standard error out functionality.

Get XY Value

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

• WDT Get XY Value DBL VI


• WDT Get XY Value I64 VI
• WDT Get XY Value I32 VI

© National Instruments 875


Functions

• WDT Get XY Value I16 VI


• WDT Get XY Value CDB VI
• WDT Get XY Value EXT VI
• WDT Get XY Value CXT VI
• DWDT Get XY Value VI
• DTbl Get Digital Value VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Y Value.vi

WDT Get XY Value DBL VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the analog waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.
1 Relative Time—Returns the data value at a specified time relative to the first point in the

876 ni.com
Functions

waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

• Y value —

Y value returns the Y value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 877


Functions

• labview\examples\Waveform\Waveform - Get Y Value.vi

WDT Get XY Value I64 VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the analog waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1
waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

• error in (no error) —

878 ni.com
Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

• Y value —

Y value returns the Y value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Y Value.vi

WDT Get XY Value I32 VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

© National Instruments 879


Functions

Inputs/Outputs
• waveform in —

waveform in is the analog waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1
waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

880 ni.com
Functions

• Y value —

Y value returns the Y value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Y Value.vi

WDT Get XY Value I16 VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the analog waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.

© National Instruments 881


Functions

Relative Time—Returns the data value at a specified time relative to the first point in the
1
waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

• Y value —

Y value returns the Y value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

882 ni.com
Functions

• labview\examples\Waveform\Waveform - Get Y Value.vi

WDT Get XY Value CDB VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the analog waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1
waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

• error in (no error) —

© National Instruments 883


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

• Y value —

Y value returns the Y value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Y Value.vi

WDT Get XY Value EXT VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

884 ni.com
Functions

Inputs/Outputs
• waveform in —

waveform in is the analog waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1
waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

© National Instruments 885


Functions

• Y value —

Y value returns the Y value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Y Value.vi

WDT Get XY Value CXT VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the analog waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.

886 ni.com
Functions

Relative Time—Returns the data value at a specified time relative to the first point in the
1
waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

• Y value —

Y value returns the Y value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 887


Functions

• labview\examples\Waveform\Waveform - Get Y Value.vi

DWDT Get XY Value VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

Inputs/Outputs
• waveform in —

waveform in is the digital waveform for which you want to retrieve a specified data value (X and
Y value). The default is empty.

• Y position format —

Y position format indicates if you want to retrieve the data value of the specified element or at a
specified time.

0 Samples—Returns the data value of the specified sample in the waveform data.
Relative Time—Returns the data value at a specified time relative to the first point in the
1
waveform.

• Y position —

Y position is the element number you want from the set of waveform data or the value at a
specified time. The default is 0.

For example, if you want the value of the 200th scan, wire 199 to this input. If you want the value
at time 100, wire 100 to this input. You select whether this is a samples or relative time Y
position format. In Relative Time mode, this VI checks the Y position input to determine if it is
an integer multiple of dt. If Y position is not an integer multiple of dt, the VI uses the closest
exact multiple of dt.

888 ni.com
Functions

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X value —

X value returns the X value.

• waveform out —

waveform out returns waveform in unchanged.

• actual Y position —

actual Y position is the actual index or time value of the point returned.

• Y value —

Y value returns an array of Y values.

• error out —

error out contains error information. This output provides standard error out functionality.

• waveform data value —

waveform data value returns the values of the waveform data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Y Value.vi

DTbl Get Digital Value VI

Returns the X and Y value of a waveform or digital data set. The data type you wire to
the waveform in input and the data type of the Y component of the analog waveform
determine the polymorphic instance to use.

© National Instruments 889


Functions

Inputs/Outputs
• digital data in —

digital data in is the set of digital data for which you want to retrieve the X and Y values.

• Start —

Start is the data element or time value where you want to start acquiring X and Y values.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• Compressed Index —

Compressed Index returns the index of the data element or time value with respect to the
compressed waveform. For example, if the actual sample number is 8 but the sample is
compressed in a portion of the waveform that starts at 3, the compressed index is 3.

• digital data out —

digital data out returns digital data in unchanged.

• Sample Number —

Sample Number returns the sample number of the data element or time value. If the value of
Start is inside a compressed portion of the waveform, Sample Number is the sample number
calculated as if the waveform was not compressed.

• digital value —

digital value returns an array of Y values.

• error out —

error out contains error information. This output provides standard error out functionality.

890 ni.com
Functions

• digital data value —

digital data value returns the values of the digital data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Y Value.vi

Get Waveform Time Array

Creates an array of waveform time stamps. Each element in the array is the time stamp
for each data value in the waveform. Wire data to the waveform in input to determine
the polymorphic instance to use or manually select the instance.

• WDT Get Waveform Time Array DBL VI


• DWDT Get Waveform Time Array VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Time Array.vi

WDT Get Waveform Time Array DBL VI

Creates an array of waveform time stamps. Each element in the array is the time stamp
for each data value in the waveform. Wire data to the waveform in input to determine
the polymorphic instance to use or manually select the instance.

© National Instruments 891


Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the time stamp information.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X array —

X array is the array of waveform time stamps.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Time Array.vi

DWDT Get Waveform Time Array VI

Creates an array of waveform time stamps. Each element in the array is the time stamp
for each data value in the waveform. Wire data to the waveform in input to determine
the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the digital waveform for which you want to retrieve the time stamp information.

892 ni.com
Functions

• match transition array —

match transition array specifies whether the timestamp array output contains a timestamp for
every Y value in a digital waveform or for only the Y values identified as transitions in a
compressed digital waveform. The default is FALSE, which means this VI returns the timestamps
of all Y values in the digital waveform.

If the digital waveform is uncompressed, this VI treats this input as FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• X array —

X array is the array of waveform time stamps.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Get Time Array.vi

Analog Waveform

Use the Analog Waveform VIs and functions to perform arithmetic and comparison
functions on waveforms.

Note Many Analog Waveform VIs are available only in the LabVIEW Full and
Professional Development Systems. If you have the LabVIEW Base
Development System, you do not have the full set of the Analog Waveform
VIs described in this help file.

The VIs and functions on this palette can return waveform error codes.

© National Instruments 893


Functions

Palette Object Description


Get Waveform Returns the analog waveform you specify. You specify components by clicking on
Components the center of the output terminal and selecting the component you want.
Builds an analog waveform or modifies an existing waveform. If you do not wire the
Build waveform input, the function creates a new waveform based on the components
Waveform you wire. If you wire the waveform input, the function modifies the waveform
based on the components you wire.
Set Waveform
Adds or replaces a waveform attribute. You can use any type of data for the value
Attribute
of the attribute.
Function
Get Waveform
Retrieves the names and values of all attributes or the value of a single attribute,
Attribute
depending on whether you wire the name parameter.
Function

Waveform
Scales the waveform data using the equation waveform out = (scale * waveform in
Scale and
+ offset).
Offset

Normalize Determines the scale and offset necessary to transform the waveform data so that
Waveform its maximum is 1.00 and its minimum is -1.00.

Appends waveform B to the end of waveform A. If the sampling rates do not


Append match, the error cluster returns an error. The trigger time of waveform B is ignored.
Waveforms The data type of the Y component of waveform A and waveform B determines the
polymorphic instance to use or you can manually select the instance.

Number of
Returns the number of data elements in the waveform. You must manually select
Waveform
the polymorphic instance you want to use.
Samples

Waveform Min Determines the maximum and minimum values and their associate time values for
Max a waveform.

894 ni.com
Functions

Palette Object Description


Waveform
Scalar Limit Compares the waveform data values to a scalar value.
Comparison

Search
Returns the time value in x for the value specified.
Waveform

Creates an array of data values and their corresponding time stamps. Wire the data
Waveform to
type of the Y component to the waveform in input to determine the polymorphic
XY Pairs
instance to use or manually select the instance.

Waveform
Use the waveform constant to hold acquired data for analysis and display.
Constant

Waveform Use the Waveform Generation VIs to generate different types of single and multi-
Generation tone signals, function generator signals, and noise signals.

Use the Waveform Measurements VIs to perform common time and frequency
Waveform
domain measurements, such as DC, RMS, Tone Frequency/Amplitude/Phase,
Measurements
Harmonic Distortion, SINAD, and Averaged FFT Measurements.

Get Waveform Components

Returns the analog waveform you specify. You specify components by clicking on the
center of the output terminal and selecting the component you want.

Inputs/Outputs
• waveform —

© National Instruments 895


Functions

waveform is the waveform from which you want to retrieve components.

• t0 —

t0 returns the trigger time of the waveform.

• dt —

dt returns the time interval in seconds between data points in the waveform.

• Y—

Y returns the data values of the waveform.

• attributes —

attributes returns the names and values of all waveform attributes.

You also can use the Get Waveform Attribute VI to retrieve the names and values of all attributes
or the value of a single attribute.

Build Waveform

Builds an analog waveform or modifies an existing waveform. If you do not wire the
waveform input, the function creates a new waveform based on the components you
wire. If you wire the waveform input, the function modifies the waveform based on the
components you wire.

Inputs/Outputs
• waveform —

waveform is the analog waveform you want to edit. If you do not wire an existing waveform, the
function creates a new waveform based on the components you wire.

• t0 —

896 ni.com
Functions

t0 specifies the start time of the waveform.

• dt —

dt specifies the time interval in seconds between data points in the waveform.

• Y—

Y specifies the data values of the waveform.

• attributes —

attributes sets the names and values of all waveform attributes.

You also can use the Set Waveform Attribute function to set the name and value of a single
attribute.

• output waveform —

waveform is the resulting waveform. If you did not wire an existing waveform, this is a new
waveform. If you wired an existing waveform, this is the edited waveform.

Set Waveform Attribute Function

Adds or replaces a waveform attribute. You can use any type of data for the value of
the attribute.

Inputs/Outputs
• waveform —

waveform is the waveform for which you want to add or replace an attribute.

• name —

name is the name of the attribute.

© National Instruments 897


Functions

• value —

value is the value of the attribute. This input is polymorphic, so you can wire any data to it.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform with the new or replaced attribute.

• replaced —

replaced indicates if an attribute was overwritten.

• error out —

error out contains error information. This output provides standard error out functionality.

If the attribute in name already exists, the function overwrites the attribute with the
new value, and replaced is TRUE. If the attribute in name does not exist already, the
function creates a new attribute. Some attributes are set by NI-DAQ and Express VIs.

The following table lists the waveform attributes set by NI-DAQ.

Data
Name Attribute Acceptable Values Description
Type
Hardware Any value is NI_DeviceNumber is the device
Device NI_DeviceNumber String acceptable for number of the hardware producing
Number NI_DeviceNumber. the waveform.
Any value is NI_ChannelName is the name of the
Name of
NI_ChannelName String acceptable for virtual channel producing the
Channel
NI_ChannelName. waveform.
NI_LineNames is the name of the
Name of Any value is digital line in the waveform. For more
Digital NI_LineNames String acceptable for than one digital line, the function
Line(s) NI_LineNames. returns the line names in reverse
order.

898 ni.com
Functions

Volts, PSI, and so


forth are
Unit for NI_UnitDescription is the units of
NI_UnitDescription String acceptable values
Data measure for the waveform.
for
NI_UnitDescription.

The following table lists the waveform attributes set by Express VIs.

Data
Name Attribute Acceptable Values Description
Type
NI_ExpStartTimeStamp is
the time stamp of the first
sample in the first
waveform. In Express VIs,
this is set once per start
of the VI and does not
change, even if waveform
Any value is acceptable data is generated in a
Start Time
NI_ExpStartTimeStamp for loop. In Express VIs,
Timestamp stamp
NI_ExpStartTimeStamp. NI_ExpStartTimeStamp is
set according to the PC
clock unless the
waveform originates in
NI-DAQ. When the
waveform originates in
NI-DAQ, NI-DAQ sets
NI_ExpStartTimeStamp.
NI_ExpTimeStamp is the
time stamp of the first
sample in the waveform.
In Express VIs,
NI_ExpTimeStamp is set
Time Any value is acceptable according to the PC clock
Timestamp NI_ExpTimeStamp
stamp for NI_ExpTimeStamp. unless the waveform
originates in NI-DAQ.
When the waveform
originates in NI-DAQ, NI-
DAQ sets
NI_ExpTimeStamp.
X NI_ExpXDimension String Use a single character If the value of

© National Instruments 899


Functions

NI_ExpXDimension is t, t0
for the
and dt are unchanged. If
NI_ExpXDimension
the value of
value. Currently, only t
NI_ExpXDimension is f,
for time and f for
Dimension Express VIs interpret t0
frequency are
and dt as f0 and df. For all
supported. The value
other values, or unknown
for NI_ExpXDimension
dimension, t0 and dt are
is case sensitive.
interpreted as X0 and dX.
If and only if
TRUE or FALSE are NI_ExpXDimension is t,
Relative
NI_ExpIsRelativeTime Boolean acceptable values for Express VIs set t0 as a
Time?
NI_ExpIsRelativeTime. relative/absolute time
stamp value.

Note Express VIs also use the attributes set by NI-DAQ. If the waveform does
not originate in NI-DAQ, Express VIs add NI_ChannelName.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Create.vi

Get Waveform Attribute Function

Retrieves the names and values of all attributes or the value of a single attribute,
depending on whether you wire the name parameter.

Attributes can be channel names. The connector pane displays the default data types
for this polymorphic function.

900 ni.com
Functions

Inputs/Outputs
• waveform —

waveform is the waveform for which you want to retrieve an attribute(s) and value(s).

• name —

name is the name of the attribute whose value you want to retrieve.

Do not wire this parameter if you want to retrieve all the attributes associated with the specified
waveform. If you wire name, the names output changes to a Boolean output found, the array
output values changes to an output called value of the same type as default value, and the
function searches for only the specified attribute.
• default value (empty Variant) —

default value is a value and data type that you specify. If the function does not find the attribute
specified in name, it returns the default value.

If you wire default value, you must wire name.


• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• duplicate waveform —

duplicate waveform is the waveform data you input in waveform.

• names —

names returns a 1D array containing the names of all attributes associated with the waveform.

If you wire the name parameter, this output changes to a Boolean value found. found returns
TRUE if the function finds the attribute that you specify in name.
• values —

values returns a 1D array containing the values associated with each attribute of the specified
waveform in variant format.

You must unflatten each attribute value to an appropriate data type. If you wire name, this
output changes to a single variant value. If the function does not find the attribute that you
specify in name, it returns the value passed to default value.
• error out —

© National Instruments 901


Functions

error out contains error information. This output provides standard error out functionality.

This function has two modes of behavior depending on whether you wire the name
parameter. By default, the function returns the names of all attributes and their
corresponding values in 1D arrays. If you wire name, the names output changes to a
Boolean output found, the values output changes to a variant output value, and the
function searches for only the specified attribute. If the function does not find the
specified attribute(s), or if it cannot convert the attribute(s) to the default value, found
is FALSE, and value displays the contents of default value.

The following table lists the waveform attributes set by NI-DAQ.

Data
Name Attribute Acceptable Values Description
Type
Hardware NI_DeviceNumber is the device
Any value is acceptable
Device NI_DeviceNumber String number of the hardware device
for NI_DeviceNumber.
Number producing the waveform.
NI_ChannelName is the name of
Name of Any value is acceptable
NI_ChannelName String the virtual channel producing
Channel for NI_ChannelName.
the waveform.
Name of
Any value is acceptable NI_LineNames is the name of
Digital NI_LineNames String
for NI_LineNames. the digital line in the waveform.
Line(s)
Volts, PSI, and so forth
Unit for NI_UnitDescription is the units
NI_UnitDescription String are acceptable values for
Data of measure for the waveform.
NI_UnitDescription.

The following table lists the waveform attributes set by Express VIs.

Data
Name Attribute Acceptable Values Description
Type
NI_ExpStartTimeStamp is
Any value is acceptable
Start Time the time stamp of the first
NI_ExpStartTimeStamp for
Timestamp stamp sample in the first
NI_ExpStartTimeStamp.
waveform. In Express VIs,

902 ni.com
Functions

Data
Name Attribute Acceptable Values Description
Type
this is set once per start
of the VI and does not
change, even if waveform
data is generated in a
loop. In Express VIs,
NI_ExpStartTimeStamp is
set according to the PC
clock unless the
waveform originates in
NI-DAQ. When the
waveform originates in
NI-DAQ, NI-DAQ sets
NI_ExpStartTimeStamp.
NI_ExpTimeStamp is the
time stamp of the first
sample in the waveform.
In Express VIs,
NI_ExpTimeStamp is set
Time Any value is acceptable according to the PC clock
Timestamp NI_ExpTimeStamp
stamp for NI_ExpTimeStamp. unless the waveform
originates in NI-DAQ.
When the waveform
originates in NI-DAQ, NI-
DAQ sets
NI_ExpTimeStamp.
If the value of
NI_ExpXDimension is t, t0
Use a single character
and dt are unchanged. If
for the
the value of
NI_ExpXDimension
NI_ExpXDimension is f,
value. Currently, only t
X Express VIs interpret t0
NI_ExpXDimension String for time and f for
Dimension and dt as f0 and df. For all
frequency are
other values, Express VIs
supported. The value
generically interpret t0
for NI_ExpXDimension
and dt as X0 and dX, but
is case sensitive.
there is no effect
otherwise.
Relative TRUE or FALSE are If and only if
NI_ExpIsRelativeTime Boolean
Time? acceptable values for NI_ExpXDimension is t,

© National Instruments 903


Functions

Data
Name Attribute Acceptable Values Description
Type
Express VIs set t0 as a
NI_ExpIsRelativeTime. relative/absolute time
stamp value.

Note Express VIs also use the attributes set by NI-DAQ. If the waveform does
not originate in NI-DAQ, Express VIs add NI_ChannelName.

Waveform Scale and Offset

Scales the waveform data using the equation waveform out = (scale * waveform in +
offset).

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to multiply the data values.

• offset —

offset is the value to add to the waveform values according to the following equation: y = (scale
* x) + offset, where x is the data from the waveform in and y is the data written to the waveform
out. The default is 0.

• scale —

scale is the number by which you multiply the waveform data values. A value of greater than
zero but less than 1 decreases the waveform amplitude. A value of greater than 1 increases the
waveform amplitude. The default is 1.0.

• error in (no error) —

904 ni.com
Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the resulting waveform with the new scaled data values.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Scale and Offset.vi

Normalize Waveform

Determines the scale and offset necessary to transform the waveform data so that its
maximum is 1.00 and its minimum is -1.00.

Inputs/Outputs
• waveform in —

waveform in is the waveform you want to normalize.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• normalized waveform —

© National Instruments 905


Functions

normalized waveform is the resulting signal.

• scale —

scale identifies the factor by which the waveform was multiplied.

• offset —

offset identifies the amount the waveform was shifted.

• error out —

error out contains error information. This output provides standard error out functionality.

The transformation is given by the following equation.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Normalize.vi

Append Waveforms

Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

• WDT Append Waveforms DBL VI


• WDT Append Waveforms I64 VI
• WDT Append Waveforms I32 VI
• WDT Append Waveforms I16 VI

906 ni.com
Functions

• WDT Append Waveforms CDB VI


• WDT Append Waveforms EXT VI
• WDT Append Waveforms CXT VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

WDT Append Waveforms DBL VI


Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

Inputs/Outputs
• waveform A —

waveform A is the first set of data in the waveform.

• waveform B —

waveform B is the set of data appended to the end of waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform that results from appending waveform B to waveform A.

© National Instruments 907


Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

WDT Append Waveforms I64 VI


Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

Inputs/Outputs
• waveform A —

waveform A is the first set of data in the waveform.

• waveform B —

waveform B is the set of data appended to the end of waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform that results from appending waveform B to waveform A.

908 ni.com
Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

WDT Append Waveforms I32 VI


Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

Inputs/Outputs
• waveform A —

waveform A is the first set of data in the waveform.

• waveform B —

waveform B is the set of data appended to the end of waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform that results from appending waveform B to waveform A.

© National Instruments 909


Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

WDT Append Waveforms I16 VI


Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

Inputs/Outputs
• waveform A —

waveform A is the first set of data in the waveform.

• waveform B —

waveform B is the set of data appended to the end of waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform that results from appending waveform B to waveform A.

910 ni.com
Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

WDT Append Waveforms CDB VI


Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

Inputs/Outputs
• waveform A —

waveform A is the first set of data in the waveform.

• waveform B —

waveform B is the set of data appended to the end of waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform that results from appending waveform B to waveform A.

© National Instruments 911


Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

WDT Append Waveforms EXT VI


Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

Inputs/Outputs
• waveform A —

waveform A is the first set of data in the waveform.

• waveform B —

waveform B is the set of data appended to the end of waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform that results from appending waveform B to waveform A.

912 ni.com
Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

WDT Append Waveforms CXT VI


Appends waveform B to the end of waveform A. If the sampling rates do not match,
the error cluster returns an error. The trigger time of waveform B is ignored. The data
type of the Y component of waveform A and waveform B determines the polymorphic
instance to use or you can manually select the instance.

Inputs/Outputs
• waveform A —

waveform A is the first set of data in the waveform.

• waveform B —

waveform B is the set of data appended to the end of waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform that results from appending waveform B to waveform A.

© National Instruments 913


Functions

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Append.vi

Number of Waveform Samples

Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

• WDT Number of Waveform Samples DBL VI


• WDT Number of Waveform Samples CDB VI
• WDT Number of Waveform Samples EXT VI
• WDT Number of Waveform Samples I16 VI
• WDT Number of Waveform Samples I32 VI
• WDT Number of Waveform Samples I8 VI
• WDT Number of Waveform Samples SGL VI

WDT Number of Waveform Samples DBL VI


Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

914 ni.com
Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the number of data elements.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• number of samples —

number of samples is the number of data elements in the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Number of Waveform Samples CDB VI


Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the number of data elements.

• error in (no error) —

© National Instruments 915


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• number of samples —

number of samples is the number of data elements in the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Number of Waveform Samples EXT VI


Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the number of data elements.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• number of samples —

916 ni.com
Functions

number of samples is the number of data elements in the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Number of Waveform Samples I16 VI


Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the number of data elements.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• number of samples —

number of samples is the number of data elements in the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 917


Functions

WDT Number of Waveform Samples I32 VI


Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the number of data elements.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• number of samples —

number of samples is the number of data elements in the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Number of Waveform Samples I8 VI


Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

918 ni.com
Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the number of data elements.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• number of samples —

number of samples is the number of data elements in the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

WDT Number of Waveform Samples SGL VI


Returns the number of data elements in the waveform. You must manually select the
polymorphic instance you want to use.

Inputs/Outputs
• waveform in —

© National Instruments 919


Functions

waveform in is the waveform for which you want to retrieve the number of data elements.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• number of samples —

number of samples is the number of data elements in the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Waveform Min Max

Determines the maximum and minimum values and their associate time values for a
waveform.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve the maximum and minimum values.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

920 ni.com
Functions

• max time —

max time is the time value at which the maximum data value was reached.

• waveform out —

waveform out returns waveform in unchanged.

• Y max —

Y max is the maximum data value of the waveform.

• Y min —

Y min is the minimum data value of the waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

• min time —

min time is the time value at which the minimum data value was reached.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Min Max.vi

Waveform Scalar Limit Comparison

Compares the waveform data values to a scalar value.

Inputs/Outputs
• data —

© National Instruments 921


Functions

data is the waveform that includes the data you want to compare to a specified limit.

• compare condition —

compare condition indicates whether the highest or lowest data value of waveform must be
lower than and/or equal to or higher than and/or equal to the number in limit.

0 <—The highest or lowest value in the waveform is less than the limit.
1 <=—The highest or lowest value in the waveform is less than or equal to the limit.
2 >—The highest or lowest value in the waveform is greater than the limit.
3 >= (default)—The highest or lowest value in the waveform is greater than or equal to the limit.

• limit —

limit specifies the number to which you want to compare the highest or lowest data value in the
waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• output waveforms —

output waveforms returns two waveforms in an array.

The first is a copy of data. The second is the failure waveform, which is a copy of data with all
elements that passed replaced by NaN. All valid elements are failures.

• passed? —

passed? indicates whether the highest or lowest data value met the compare condition based
on the limit. FALSE indicates the highest or lowest data value did not meet the comparison.

• error out —

error out contains error information. This output provides standard error out functionality.

passed? is FALSE if any point in the waveform fails the specified comparison. For
example, passed? is FALSE if any waveform point is greater than the limit value when
compare condition is set to <.

922 ni.com
Functions

This VI also returns an array of waveforms where the first waveform is the original data.
The second waveform contains the data with the failed limit comparison values
replaced by NaN.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Scalar Limit


Comparison.vi

Search Waveform

Returns the time value in x for the value specified.

Inputs/Outputs
• tolerance (%) —

tolerance is the percent tolerance on the input value for a match. The default is 0.01.

• waveform in —

waveform in is the waveform you want to search for a particular data value. The default is
empty.

• value —

value is the data value for which you want to search. The default is 0.

• start index —

start index defines the point in the waveform data where the search begins. The default is 0, the
beginning of the waveform. The VI returns an error if start index is out of range for the waveform.

© National Instruments 923


Functions

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• indices of fits —

indices of fits is an array of indexes of all values that meet the input value and tolerance criteria.

• waveform out —

waveform out returns waveform in unchanged.

• index of best fit —

index of best fit is the index of the data value that best matches the input value.

• time of best fit —

time of best fit is the time value where the data value that best matches the input value was
found.

• error out —

error out contains error information. This output provides standard error out functionality.

• time of fits —

time of fits is an array of all time values of all values that meet the input value and tolerance
criteria.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Search.vi

Waveform to XY Pairs

Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

924 ni.com
Functions

• WDT Waveform to XY Pairs DBL VI


• WDT Waveform to XY Pairs SGL VI
• WDT Waveform to XY Pairs I64 VI
• WDT Waveform to XY Pairs I32 VI
• WDT Waveform to XY Pairs I16 VI
• WDT Waveform to XY Pairs I8 VI
• WDT Waveform to XY Pairs U64 VI
• WDT Waveform to XY Pairs U32 VI
• WDT Waveform to XY Pairs U16 VI
• WDT Waveform to XY Pairs U8 VI
• WDT Waveform to XY Pairs CDB VI
• WDT Waveform to XY Pairs CSG VI
• WDT Waveform to XY Pairs EXT VI
• WDT Waveform to XY Pairs CXT VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs DBL VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

© National Instruments 925


Functions

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs SGL VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

926 ni.com
Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

© National Instruments 927


Functions

WDT Waveform to XY Pairs I64 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

928 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs I32 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

© National Instruments 929


Functions

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs I16 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

930 ni.com
Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs I8 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

© National Instruments 931


Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

932 ni.com
Functions

WDT Waveform to XY Pairs U64 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

© National Instruments 933


Functions

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs U32 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

934 ni.com
Functions

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs U16 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

© National Instruments 935


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs U8 VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

936 ni.com
Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

© National Instruments 937


Functions

WDT Waveform to XY Pairs CDB VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

938 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs CSG VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

© National Instruments 939


Functions

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs EXT VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

940 ni.com
Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

WDT Waveform to XY Pairs CXT VI


Creates an array of data values and their corresponding time stamps. Wire the data
type of the Y component to the waveform in input to determine the polymorphic
instance to use or manually select the instance.

© National Instruments 941


Functions

Inputs/Outputs
• waveform in —

waveform in is the waveform for which you want to retrieve data values and corresponding time
stamps.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out returns waveform in unchanged.

• XY pairs —

XY pairs is the data values of the waveforms and their corresponding time stamps.

• x—

x is the time stamp of y.

• y—

y is the data value.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - XY Pairs.vi

942 ni.com
Functions

Waveform Constant

Use the waveform constant to hold acquired data for analysis and display.

The waveform constant consists of components that include a start time, a delta t, the
waveform data, and attributes. Use the Analog Waveform VIs and functions to access
and manipulate individual components of a waveform.

The start time (t0) is a time stamp associated with the first measurement point in the
waveform. Use the start time to synchronize plots on a multi-plot waveform graph or
digital waveform graph and to determine delays between waveforms. Delta t (dt) is the
time interval in seconds between any two points in the signal. The waveform data is
the value that represents the waveform. An array of any numeric data type other than
the fixed-point numeric data type can represent analog waveform data. Generally, the
number of data values in the array corresponds directly to the number of scans from a
DAQ device. Attributes include information about the signal, such as the name of the
signal and the device acquiring the signal. NI-DAQ automatically sets some attributes
for you. Use the Set Waveform Attribute function to set attributes, and use the Get
Waveform Attribute function to read attributes.

Use the Get Waveform Components function to extract and manipulate the
components of a waveform you generate. The Negate function negates waveform data
and plots the results to a graph.

To represent waveform data in the front panel window, use the waveform control or
the waveform graph.

Waveform Generation

Use the Waveform Generation VIs to generate different types of single and multi-tone
signals, function generator signals, and noise signals.

The VIs on this palette can return waveform error codes.

© National Instruments 943


Functions

Palette Object Description


Basic
Function Creates an output waveform based on signal type.
Generator
Tones and
Noise Generates a waveform composed of a sum of sine tones, noise, and DC offset.
Waveform

Formula Creates an output waveform using a formula string to specify the time function to
Waveform be used.

Sine
Generates a waveform containing a sine wave.
Waveform

Square
Generates a waveform containing a square wave.
Waveform

Triangle
Generates a waveform containing a triangle wave.
Waveform

Sawtooth
Generates a waveform containing a sawtooth wave.
Waveform

Basic
Generates a waveform that is the sum of integer cycle sine tones.
Multitone

Basic
Multitone with Generates a waveform that is the sum of integer cycle sine tones.
Amplitudes

Multitone
Generates a waveform that is the sum of integer cycle sine tones.
Generator

Uniform White
Generates a uniformly distributed pseudorandom pattern whose values are in the
Noise
range [–a:a], where a is the absolute value of amplitude.
Waveform

944 ni.com
Functions

Palette Object Description

Gaussian
Generates a Gaussian distributed pseudorandom pattern whose statistical profile is
White Noise
(0,s), where s is the absolute value of the specified standard deviation.
Waveform

Periodic
Random
Generates a waveform containing periodic random noise (PRN).
Noise
Waveform

Inverse f
Generates a continuous noise waveform with a power spectral density that is
Noise
inversely proportional to frequency over a specified frequency range.
Waveform

Gamma Noise Generates a pseudorandom pattern of values which are the waiting times to the
Waveform order number event of a unit mean Poisson process.

Poisson Noise Generates a pseudorandom sequence of values which are the number of discrete
Waveform events occurring in the interval specified by mean of a unit rate Poisson process.

Binomial Generates a binomially-distributed pseudorandom pattern whose values are the


Noise number of occurrences of an event given the probability of that event occurring
Waveform and the number of trials.

Bernoulli Generates a pseudorandom pattern of ones and zeros, where the probability of
Noise generating a one is one probability and the probability of generating a zero is
Waveform (1–one probability).

MLS Sequence Generates a maximum length sequence of ones and zeros using a modulo-2
Waveform primitive polynomial of order polynomial order.

Simulate
Simulates a sine wave, square wave, triangle wave, sawtooth wave, or noise signal.
Signal

© National Instruments 945


Functions

Palette Object Description


Simulate
Arbitrary Simulates a signal that you define.
Signal

Basic Function Generator


Creates an output waveform based on signal type.

Inputs/Outputs
• offset —

offset is the DC offset of the signal. The default is 0.0.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• signal type —

signal type is the type of waveform to generate.

Sine Wave
0
(default)
1 Triangle Wave
2 Square Wave
3 Sawtooth Wave

• frequency —

946 ni.com
Functions

frequency is the frequency of the waveform in units of hertz. The default is 10.

• amplitude —

amplitude is the amplitude of the waveform. The amplitude is also the peak voltage. The default
is 1.0.

• phase —

phase is the initial phase, in degrees, of the waveform. The default is 0. The VI ignores phase if
reset signal is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• square wave duty cycle (%) —

square wave duty cycle is the percentage of time a square wave remains high versus low over
one period. The VI uses this parameter only if the signal type is a square wave. The default is 50.

• signal out —

signal out is the generated waveform.

• phase out —

phase out is the phase of the waveform in degrees.

• error out —

© National Instruments 947


Functions

error out contains error information. This output provides standard error out functionality.

This VI remembers the time stamp of the previous waveform generated and continues
to increment the time stamp from that point. It takes as inputs the type of waveform,
number of samples, phase in, and the frequency of the waveform to be generated in
Hz.

Tones and Noise Waveform


Generates a waveform composed of a sum of sine tones, noise, and DC offset.

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the phase of each tone to the phase value from the tones array, the
seed to the seed control value, and the time stamp to zero. The default is FALSE.

• tones —

tones contains the parameters for each sine tone.

• frequency —

frequency specifies the frequency of the sine tone in hertz.

• amplitude —

amplitude specifies the amplitude of the sine tone.

• phase —

948 ni.com
Functions

phase specifies the initial phase of the sine tone in degrees. The default is 0.

• noise (rms) —

noise specifies the rms level of the additive Gaussian noise. The default is 0.0.

• offset —

offset is the DC offset of the signal. The default is 0.0.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• signal out —

© National Instruments 949


Functions

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Mathematics\Interpolation\1D Fourier
Interpolation.vi

Formula Waveform
Creates an output waveform using a formula string to specify the time function to be
used.

Inputs/Outputs
• offset —

offset is the DC offset of the signal. The default is 0.0.

• reset signal —

reset signal, if TRUE, resets the time stamp to zero. The default is FALSE.

• frequency —

frequency is the frequency of the waveform in units of hertz. The default is 100.

950 ni.com
Functions

• amplitude —

amplitude is the amplitude of the waveform. The amplitude is also the peak voltage. The default
is 1.0.

• formula —

formula is the representation used to generate the signal out waveform. The default is
sin(w*t)*sin(2*pi(1)*10).

The following table lists the defined variable names.

f Frequency equal to the frequency input


a Amplitude equal to the amplitude input
w 2*pi*f
n Number of samples generated so far
t Number of elapsed seconds
fs Sampling frequency equal to sampling info→>Fs

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

© National Instruments 951


Functions

error out contains error information. This output provides standard error out functionality.

Related Information

Formula Node and Expression Node Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Waveform Generation Using Formula.vi

Sine Waveform
Generates a waveform containing a sine wave.

Inputs/Outputs
• offset —

offset is the DC offset of the signal. The default is 0.0.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• frequency —

952 ni.com
Functions

frequency is the frequency of the waveform in units of hertz. The default is 10.

• amplitude —

amplitude is the amplitude of the waveform. The amplitude is also the peak voltage. The default
is 1.0.

• phase —

phase is the initial phase, in degrees, of the waveform. The default is 0. The VI ignores phase if
reset signal is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

If sine wave is represented by the sequence Y, the VI generates the pattern according to
the following equation.

y[i] = amp × sin(phase[i]), for i = 0, 1, 2, …, n – 1,

© National Instruments 953


Functions

where amp = amplitude, n = number of samples (#s), and phase[i] is:

initial_phase + frequency × 360.0 × i/Fs

This VI initializes the phase on the first run. After the first run, if reset signal is TRUE,
phase sets the initial phase of the input signal. If reset signal is FALSE, the VI ignores
phase.

This VI is reentrant so that it can be used to simulate a continuous acquisition from a


sine wave function generator. If the input control reset signal is FALSE, subsequent
calls to this VI produce the output sine wave waveform containing the next n samples
of a sine wave. This VI remembers the phase and time stamp of the current waveform
and uses this to continuously generate and time stamp the subsequent waveforms, as
long as the reset signal input is FALSE.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Noise Waveforms and PS Density.vi

Square Waveform
Generates a waveform containing a square wave.

Inputs/Outputs
• offset —

954 ni.com
Functions

offset is the DC offset of the signal. The default is 0.0.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• frequency —

frequency is the frequency of the waveform in units of hertz. The default is 10.

• amplitude —

amplitude is the amplitude of the waveform. The amplitude is also the peak voltage. The default
is 1.0.

• phase —

phase is the initial phase, in degrees, of the waveform. The default is 0. The VI ignores phase if
reset signal is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• duty cycle (%) —

duty cycle is the percentage of time a square wave remains high versus low over one period. The
default is 50.

© National Instruments 955


Functions

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

If square wave is represented by the sequence Y, the VI generates the pattern according
to the following equation.

y[i] = amp × square(phase[i]), for i = 0, 1, 2, …, n – 1,

where amp = amplitude, n = number of samples (#s), and square[p] is:

1.0 if 0 ≤ pmod < (0.01 × duty) × 360.0

or

–1.0 if (0.01 × duty) × 360.0 ≤ pmod < 360.0

where pmod = p modulo 360.0, duty = duty cycle in percent, and phase[i] is:

initial_phase + frequency × 360.0 × i/Fs

where initial_phase = phase if reset signal is TRUE, or last output phase if reset signal
is FALSE.

This VI is reentrant so that it can be used to simulate a continuous acquisition from a


square wave function generator. If the input control reset signal is FALSE, subsequent
calls to this VI produce the output Square Wave waveform containing the next n
samples of a square wave. This VI remembers the phase and time stamp of the current
waveform and uses this to continuously generate and time stamp the subsequent
waveforms, as long as the reset signal input is FALSE.

956 ni.com
Functions

Triangle Waveform
Generates a waveform containing a triangle wave.

Inputs/Outputs
• offset —

offset is the DC offset of the signal. The default is 0.0.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• frequency —

frequency is the frequency of the waveform in units of hertz. The default is 10.

• amplitude —

amplitude is the amplitude of the waveform. The amplitude is also the peak voltage. The default
is 1.0.

• phase —

phase is the initial phase, in degrees, of the waveform. The default is 0. The VI ignores phase if
reset signal is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

© National Instruments 957


Functions

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

If triangle wave is represented by the sequence Y, the VI generates the pattern


according to the following equation.

y[i] = amp × tri(phase[i]), for i = 0, 1, 2, …, n – 1,

where amp = amplitude, n = number of samples (#s), and tri[p] is:

(2 × pmod/180.0) if 0 ≤ pmod < 90.0

or

(2 × (1 – pmod/180.0)) if 90.0 ≤ pmod < 270.0

or

(2 × (pmod/180.0 – 2.0)) if 270.0 ≤ pmod < 360.0

where pmod = p modulo 360.0 and phase[i] is:

initial_phase + frequency × 360.0 × i/Fs

958 ni.com
Functions

where initial_phase = phase if reset signal is TRUE, or last output phase if reset signal
is FALSE.

This VI is reentrant so that it can be used to simulate a continuous acquisition from a


triangle wave function generator. If the input control reset signal is FALSE, subsequent
calls to this VI produce the output triangle wave waveform containing the next n
samples of a triangle wave. This VI remembers the phase and time stamp of the
current waveform and uses this to continuously generate and time stamp the
subsequent waveforms, as long as the reset signal input is FALSE.

Sawtooth Waveform
Generates a waveform containing a sawtooth wave.

Inputs/Outputs
• offset —

offset is the DC offset of the signal. The default is 0.0.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• frequency —

frequency is the frequency of the waveform in units of hertz. The default is 10.

• amplitude —

amplitude is the amplitude of the waveform. The amplitude is also the peak voltage. The default

© National Instruments 959


Functions

is 1.0.

• phase —

phase is the initial phase, in degrees, of the waveform. The default is 0. The VI ignores phase if
reset signal is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

If Sawtooth Wave is represented by the sequence Y, the VI generates the pattern


according to the following equation.

y[i] = amp × sawtooth(phase[i]), for i = 0, 1, 2, …, n – 1,

where amp = amplitude, n = number of samples (#s), and sawtooth (phase[i]) is:

(pmod/180.0) if 0 ≤ pmod < 180.0

960 ni.com
Functions

or

(pmod/180.0 - 2.0) if 180.0 ≤ pmod < 360.0

where pmod = p modulo 360.0 and phase[i] is:

initial_phase + frequency × 360.0 × i/Fs

where initial_phase = phase if reset signal is TRUE, or last output phase if reset signal
is FALSE.

This VI is reentrant so that it can be used to simulate a continuous acquisition from a


sawtooth wave function generator. If the input control reset signal is FALSE,
subsequent calls to this VI produce the output Sawtooth Wave waveform containing
the next n samples of a sawtooth wave. This VI remembers the phase and time stamp
of the current waveform and uses this to continuously generate and time stamp the
subsequent waveforms, as long as the reset signal input is FALSE.

Basic Multitone
Generates a waveform that is the sum of integer cycle sine tones.

Inputs/Outputs
• amplitude —

amplitude is the value that the sum of all the tones is scaled to and is the largest absolute value
that the waveform contains. The default is –1.

© National Instruments 961


Functions

amplitude is useful when outputting the waveform to an analog output channel. If the
maximum value that the hardware can output is 5 volts, set amplitude to 5. If amplitude ≤ 0, the
scaling is not applied.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• #tones —

#tones is the number of tones present in the output waveform.

• start frequency —

start frequency is the lowest tone frequency generated. This value must be an integer multiple
of Fs/#s. The default is 10.

• seed —

seed, when > 0, causes reseeding of the noise sample generator.

seed is ignored if phase relationship is set to Linear.

• delta frequency —

delta frequency is the magnitude of the spacing between adjacent tone frequencies. delta
frequency must be an integer multiple of Fs/#s.

If start frequency is 100 Hz, delta frequency is ten, and #tones is three, the tone frequencies
generated are 100 Hz, 110 Hz, and 120 Hz.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

962 ni.com
Functions

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• coerce frequencies? —

If coerce frequencies? is TRUE, the specified tone frequencies will be coerced to the nearest
multiple of Fs/n.

• phase relationship —

phase relationship is the distribution of the phases of the sine tones. The phase distribution
affects the Peak/RMS ratio of the overall waveform.

0 random—Each phase is chosen randomly between 0 and 360 degrees.


linear difference—The phase difference between adjacent frequency tones varies linearly from
1 0 to 360 degrees. This gives the best Peak/RMS ratio but might cause the signal to have
periodic components within the period of the overall waveform.
2 linear phase—The phase varies linearly from 0 to 360 degrees.

• signal out —

signal out is the generated waveform.

• crest factor —

crest factor is the ratio of the Peak voltage to the RMS voltage of signal out.

• actual tone frequencies —

actual tone frequencies are the tone frequencies generated after accounting for coercion, if
coerce frequencies? is TRUE, and the Nyquist criteria.

• error out —

error out contains error information. This output provides standard error out functionality.

The frequency domain representation of this waveform is a sequence of impulses at

© National Instruments 963


Functions

the specified tone frequencies and zero at all other frequencies. The sine tones are
generated using the frequency and samples information. The phases of the tones are
random and the amplitude of each tone is equal. This raw array then is scaled so that
the largest absolute value is equal to amplitude. Finally, the waveform is bundled. The
X0 element of the waveform is always set equal to 0 and the delta X element is set
equal to 1/Fs.

Basic Multitone with Amplitudes


Generates a waveform that is the sum of integer cycle sine tones.

Inputs/Outputs
• amplitude —

amplitude is the value that the sum of all the tones is scaled to and is the largest absolute value
that the waveform contains. The default is –1.

amplitude is useful when outputting the waveform to an analog output channel. If the
maximum value that the hardware can output is 5 volts, set amplitude to 5. If amplitude ≤ 0, the
scaling is not applied.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• start frequency —

start frequency is the lowest tone frequency generated. This value must be an integer multiple

964 ni.com
Functions

of Fs/#s. The default is 10.

• tone amplitudes —

tone amplitudes is an array in which each element is a single tone amplitude. The size of this
array determines how many tones are generated.

• seed —

seed, when > 0, causes reseeding of the noise sample generator.

seed is ignored if phase relationship is set to Linear.

• delta frequency —

delta frequency is the magnitude of the spacing between adjacent tone frequencies. delta
frequency must be an integer multiple of Fs/#s. The default is 100.

If start frequency is 100 Hz, delta frequency is ten, and the tone amplitudes array contains
three elements, the tone frequencies generated are 100 Hz, 110 Hz, and 120 Hz.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• coerce frequencies? —

If coerce frequencies? is TRUE, the specified tone frequencies will be coerced to the nearest
multiple of Fs/n.

© National Instruments 965


Functions

• phase relationship —

phase relationship is the distribution of the phases of the sine tones. The phase distribution
affects the Peak/RMS ratio of the overall waveform.

0 random—Each phase is chosen randomly between 0 and 360 degrees.


linear difference—The phase difference between adjacent frequency tones varies linearly from
1 0 to 360 degrees. This gives the best Peak/RMS ratio but might cause the signal to have
periodic components within the period of the overall waveform.
2 linear phase—The phase varies linearly from 0 to 360 degrees.

• signal out —

signal out is the generated waveform.

• crest factor —

crest factor is the ratio of the Peak voltage to the RMS voltage of signal out.

• actual tone frequencies —

actual tone frequencies are the tone frequencies generated after accounting for coercion, if
coerce frequencies? is TRUE, and the Nyquist criteria.

• error out —

error out contains error information. This output provides standard error out functionality.

The frequency domain representation of this waveform is a sequence of impulses at


the specified tone frequencies and zero at all other frequencies. The number of tones
is determined by the size of the tone amplitudes array. The sine tones are generated
using the frequency, amplitude, and samples information. The phases of the tones are
determined using the relationship specified in phase relationship. This raw array then
is scaled so that the largest absolute value is equal to amplitude. Finally, the waveform
is bundled. The X0 element of the waveform is always set equal to 0 and the delta X
element is set equal to 1/Fs.

Examples

Refer to the following example files included with LabVIEW.

966 ni.com
Functions

• labview\examples\Signal Processing\Waveform Measurements\


Multitone with Amplitudes.vi

Multitone Generator
Generates a waveform that is the sum of integer cycle sine tones.

Inputs/Outputs
• amplitude —

amplitude is the value that the sum of all the tones is scaled to and is the largest absolute value
that the waveform contains. The default is –1.

amplitude is useful when outputting the waveform to an analog output channel. If the
maximum value that the hardware can output is 5 volts, set amplitude to 5. If amplitude ≤ 0, the
scaling is not applied.

• reset signal —

reset signal, if TRUE, resets the phase to the phase control value and the time stamp to zero. The
default is FALSE.

• tone frequencies —

tone frequencies is an array in which each element is a single tone frequency. The size of this
array must match the size of the tone amplitudes array and the size of the tone phases array.

• tone amplitudes —

tone amplitudes is an array in which each element is a single tone amplitude. The size of this
array must match the size of the tone frequencies array and the size of the tone phases array.

• tone phases —

© National Instruments 967


Functions

tone phases is an array in which each element is a single tone phase in degrees. The size of this
array must match the size of the tone frequencies array and the size of the tone amplitude
array.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• coerce frequencies? —

If coerce frequencies? is TRUE, the specified tone frequencies will be coerced to the nearest
multiple of Fs/n.

• signal out —

signal out is the generated waveform.

• crest factor —

crest factor is the ratio of the Peak voltage to the RMS voltage of signal out.

• actual tone frequencies —

actual tone frequencies are the tone frequencies generated after accounting for coercion, if
coerce frequencies? is TRUE, and the Nyquist criteria.

• error out —

error out contains error information. This output provides standard error out functionality.

968 ni.com
Functions

The frequency domain representation of this waveform is a sequence of impulses at


the specified tone frequencies and zero at all other frequencies. The number of tones
is determined by the size of the array inputs tone frequencies, tone amplitudes, and
tone phases. The sine tones are generated using the frequency, phase, amplitude, and
samples information. This raw array then is scaled so the largest absolute value is
equal to amplitude. Finally, the waveform is bundled. The X0 element of the waveform
always is set equal to 0 and the delta X element is set equal to 1/Fs.

LabVIEW assumes tone phases to be referenced to the sine function. To reference tone
phases to the cosine function, add 90 degrees. Be aware that this may change the crest
factor. The following code excerpt shows how to reference tone phases to the cosine
function:

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Bandlimited Signal Generation.vi
• labview\examples\Signal Processing\Waveform Measurements\
Multitone with Amplitudes and Phases.vi

Uniform White Noise Waveform


Generates a uniformly distributed pseudorandom pattern whose values are in the
range [–a:a], where a is the absolute value of amplitude.

© National Instruments 969


Functions

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• amplitude —

amplitude is the maximum absolute value that signal out can have. The default is 1.0.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

970 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

Gaussian White Noise Waveform


Generates a Gaussian distributed pseudorandom pattern whose statistical profile is
(0,s), where s is the absolute value of the specified standard deviation.

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• standard deviation —

standard deviation is the standard deviation of the generated noise. The default is 1.0.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

© National Instruments 971


Functions

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Periodic Random Noise Waveform


Generates a waveform containing periodic random noise (PRN).

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• spectral amplitude —

spectral amplitude is the magnitude of the frequency domain components of signal out.

972 ni.com
Functions

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

The output array contains all frequencies which can be represented with an integral
number of cycles in the requested number of samples. Each frequency-domain
component has a magnitude of the input spectral amplitude and random phase.
Another way of thinking of the output array of PRN is that it is a summation of
sinusoidal signals with the same amplitudes but with random phases. The unit of
spectral amplitude is the same as the output PRN unit and is a linear measure of
amplitude, much like the other Waveform Generation VIs.

© National Instruments 973


Functions

Inverse f Noise Waveform


Generates a continuous noise waveform with a power spectral density that is inversely
proportional to frequency over a specified frequency range.

Inputs/Outputs
• reset signal (F) —

reset signal resets the noise sample generator and the time stamp to zero. The default is FALSE.

• noise density —

noise density specifies the spectral density (V/root Hz) of the ideal inverse-f noise waveform at
the frequency reference freq.

The actual inverse-f noise waveform approximates the ideal inverse-f noise over the frequency
range defined by filter specifications. Therefore, the actual spectral density of the inverse-f
noise waveform at reference freq is near noise density only if reference freq is within the design
frequency range specified in filter specifications.

• exponent —

exponent specifies the exponent of the desired inverse-f noise spectral shape.

This VI generates the inverse-f noise waveform by passing white noise through a digital filter
with a desired magnitude-squared response of 1/frequency^exponent.

• filter specifications —

filter specifications specifies the operating frequency range and the filter order of the filter.

• lower cutoff freq —

974 ni.com
Functions

lower cutoff freq specifies the lower frequency edge of the operating frequency range of the
filter.

• higher cutoff freq —

higher cutoff freq specifies the higher frequency edge of the operating frequency range of
the filter.

• order —

order specifies the number of first order stages of the inverse-f filter. Increasing order
improves the inverse-f spectral shape but requires more computation time during filter
operation.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

© National Instruments 975


Functions

#s is the number of samples in the waveform. The default is 1000.

• reference freq (Hz) —

reference freq specifies the frequency in Hz at which the spectral density of the ideal inverse-f
noise waveform is equal to noise density.

The actual inverse-f noise waveform source is designed to approximate the ideal inverse-f noise
waveform over the frequency range defined in filter specifications. Therefore, the actual
spectral density of the inverse-f noise waveform at reference freq is near noise density if
reference freq is within the design frequency range specified in filter specifications.

• signal out —

signal out returns the generated inverse-f noise waveform.

• magnitude error (dB) —

magnitude error returns the magnitude of the deviation of the actual inverse-f filter in dB when
measured against the ideal inverse-f filter.

The ideal filter has a magnitude-squared response proportional to 1/f exponent over the
frequency range specified by filter specifications.

• frequency (Hz) —

frequency returns the frequencies of the magnitude error in Hz.

• magnitude (dB) —

magnitude returns the magnitudes of the magnitude error in dB.

• expected rms —

expected rms returns the expected RMS level of the generated noise waveform.

• filter information —

filter information returns the magnitude and phase of the frequency response of the designed
inverse-f filter.

976 ni.com
Functions

• magnitude (dB) —

magnitude returns the magnitude of the frequency response of the designed inverse-f filter
in dB.

• frequency (Hz) —

frequency returns the frequencies of the frequency response of the designed inverse-f
filter in Hz.

• magnitude (dB) —

magnitude returns the magnitudes of the frequency response of the designed inverse-f
filter in dB.

• phase (deg) —

phase returns the phase of the frequency response of the designed inverse-f filter in
degrees.

• frequency (Hz) —

frequency returns the frequencies of the frequency response of the designed inverse-f
filter in Hz.

• phase (deg) —

phase returns the phases of the frequency response of the designed inverse-f filter in
degrees.

• error out —

error out contains error information. This output provides standard error out functionality.

This VI generates the inverse-f noise waveform by passing spectrally flat, or white,
noise through a digital filter with a desired magnitude-squared response of 1/
frequency^exponent.

© National Instruments 977


Functions

Gamma Noise Waveform


Generates a pseudorandom pattern of values which are the waiting times to the order
number event of a unit mean Poisson process.

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• order —

order specifies the event number of the unit mean Poisson process. order must be greater than
0. The default is 1.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• sampling info —

sampling info contains sampling information.

978 ni.com
Functions

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Poisson Noise Waveform


Generates a pseudorandom sequence of values which are the number of discrete
events occurring in the interval specified by mean of a unit rate Poisson process.

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• mean —

mean specifies the interval of a unit rate Poisson process. mean must be greater than or equal to
0. The default is 1.0.

© National Instruments 979


Functions

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Binomial Noise Waveform


Generates a binomially-distributed pseudorandom pattern whose values are the
number of occurrences of an event given the probability of that event occurring and

980 ni.com
Functions

the number of trials.

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• trial probability —

trial probability is the probability that a given trial is true (1). trial probability must be in the
range [0, 1]. The default is 0.5.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• trials —

trials is the number of trials performed for each element of signal out. The default is 1.0.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• sampling info —

sampling info contains sampling information.

© National Instruments 981


Functions

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Bernoulli Noise Waveform


Generates a pseudorandom pattern of ones and zeros, where the probability of
generating a one is one probability and the probability of generating a zero is (1–one
probability).

If one probability is 0.7, each element of signal out has a 70% chance of being one and
a 30% chance of being zero.

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• one probability —

982 ni.com
Functions

one probability specifies the probability of a given element of signal out being true (1). The
default is 0.5.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• sampling info —

sampling info contains sampling information.

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 983


Functions

MLS Sequence Waveform


Generates a maximum length sequence of ones and zeros using a modulo-2 primitive
polynomial of order polynomial order.

Inputs/Outputs
• reset signal —

reset signal, if TRUE, resets the seed to the seed control value and the time stamp to zero. The
default is FALSE.

• polynomial order —

polynomial order specifies the order of the modulo-2 primitive polynomial used to generate
signal out. The default value is 31.

• seed —

seed, when greater than 0, causes reseeding of the noise sample generator. The default is –1.

LabVIEW maintains the internal seed state independently for each instance of this reentrant VI.
For a specific instance of this VI, if seed is less than or equal to 0, LabVIEW does not reseed the
noise generator, and the noise generator resumes producing noise samples as a continuation of
the previous noise sequence.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• sampling info —

sampling info contains sampling information.

984 ni.com
Functions

• Fs —

Fs is the sampling rate in samples per second. The default is 1000.

• #s —

#s is the number of samples in the waveform. The default is 1000.

• signal out —

signal out is the generated waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

The binary Maximum Length Sequence (MLS) also is known as the Pseudo-Random
Binary Sequence (PRBS).

Simulate Signal
Simulates a sine wave, square wave, triangle wave, sawtooth wave, or noise signal.

Dialog Box Options

Option Description
Contains the following options:

• Signal type—
Signal
Type of waveform to simulate. You can simulate a sine wave, square wave, sawtooth
wave, triangle wave, or noise (DC).

© National Instruments 985


Functions

Option Description

• Frequency (Hz)—

Frequency in hertz of the waveform. The default is 10.1.

• Phase (deg)—

Initial phase in degrees of the waveform. The default is 0.

• Amplitude—

Amplitude of the waveform. The default is 1.

• Offset—

DC offset of the signal. The default is 0.

• Duty cycle (%)—

Percentage of time a square wave remains high versus low over one period. The
default is 50.

• Add noise—

Adds noise to the simulated waveform.

• Noise type—

Specifies the type of noise to add to the waveform. This option is available only when
you place a checkmark in the Add Noise checkbox.

You can add the following noise types:


◦ Uniform White Noise generates a signal that contains a uniformly distributed,
pseudorandom pattern whose values are in the range [-a:a], where a is the
absolute value of Amplitude.
◦ Gaussian White Noise generates a signal that contains a Gaussian-distributed,
pseudorandom pattern whose statistical profile is (µ,sigma) = (0,s), where s is
the absolute value of the specified Standard deviation.
◦ Periodic Random Noise generates a signal that contains periodic random noise
(PRN).
◦ Gamma Noise generates a signal that contains a pseudorandom pattern of
values that are the waiting times to the Order number event of a unit mean

986 ni.com
Functions

Option Description

Poisson process.
◦ Poisson Noise generates a signal that contains a pseudorandom sequence of
values that are the number of discrete events occurring in a given interval,
specified by Mean, of a unit rate Poisson process.
◦ Binomial Noise generates a signal that contains a binomially distributed,
pseudorandom pattern whose values are the number of occurrences of an
event, given the probability of that event occurring and the number of trials.
◦ Bernoulli Noise generates a signal that contains a pseudorandom pattern of
ones and zeros.
◦ MLS Sequence generates a signal that contains a maximum length sequence of
ones and zeros using a modulo-2 primitive polynomial of order Polynomial
order.
◦ Inverse F Noise generates a signal that contains a continuous noise waveform
with a power spectral density that is inversely proportional to frequency over a
specified frequency range.
• Noise amplitude—

Maximum absolute value the signal can have. The default is 0.6. This option is
available only when you select Uniform White Noise or Inverse F Noise from the
Noise type pull-down menu.

• Standard deviation—

Standard deviation of the noise you generate. The default is 0.6. This option is
available only when you select Gaussian White Noise from the Noise type pull-down
menu.

• Spectral amplitude—

Magnitude of the frequency domain components of the simulated signal. The default
is 0.6. This option is available only when you select Periodic Random Noise from the
Noise type pull-down menu.

• Order—

Specifies the event number of the unit mean Poisson process. The default is 0.6. This
option is available only when you select Gamma Noise from the Noise type pull-
down menu.

• Mean—

© National Instruments 987


Functions

Option Description

Specifies the interval of a unit rate Poisson process. The default is 0.6. This option is
available only when you select Poisson Noise from the Noise type pull-down menu.

• Trial probability—

Probability that a given trial is TRUE. The default is 0.6. This option is available only
when you select Binomial Noise from the Noise type pull-down menu.

• One probability—

Specifies the probability that a given element of the signal is TRUE. The default is 0.6.
This option is available only when you select Bernoulli Noise from the Noise type
pull-down menu.

• Polynomial order—

Specifies the order of the modulo-2 primitive polynomial to use to generate the
signal. The default is 0.6. This option is available only when you select MLS Sequence
from the Noise type pull-down menu.

• Seed number—

When greater than 0, causes reseeding of the noise sample generator. The default is
–1. LabVIEW maintains the internal seed state independently for each instance of this
reentrant VI. For a specific instance of this VI, if Seed number is less than or equal to
0, LabVIEW does not reseed the noise generator, and the noise generator resumes
producing noise samples as a continuation of the previous noise sequence.

• Exponent—

Specifies the exponent of the inverse-f spectral shape you want. The default is 1. This
option is available only when you select Inverse F Noise from the Noise type pull-
down menu.

Contains the following options:

• Samples per second (Hz)—


Timing
Sampling rate in samples per second. The default is 1000.

• Number of samples—

988 ni.com
Functions

Option Description

Number of samples in the signal. The default is 100.

• Automatic—

Sets the Number of samples to be one-tenth of Samples per second (Hz).

• Integer number of cycles—

Sets the nearest frequency and Number of samples such that the waveform contains
an integer number of cycles.

• Actual number of samples—

Indicates the actual number of samples in the waveform when you select Integer
number of cycles.

• Actual frequency—

Indicates the actual frequency of the waveform when you select Integer number of
cycles.

• Simulate acquisition timing—

Simulates an acquisition rate comparable to an actual acquisition rate.

• Run as fast as possible—

Simulates the signal as quickly as the system allows.

Contains the following options:

• Absolute (date and time)—

Displays the timestamp in terms of time elapsed since 12:00 a.m., Friday, January 1,
Time 1904, Universal Time [01-01-1904 00:00:00].
Stamps
• Relative to start of measurement—

Displays the timestamp in terms of seconds starting from zero. For example, 100 in
relative time equals 1 minute and 40 seconds.

© National Instruments 989


Functions

Option Description
Contains the following options:

• Reset phase, seed, and time stamps—

Resets the phase to the phase value and the time stamp to zero. Resets the seed
Reset number to –1.
Signal
• Use continuous generation—

Continuously simulates the signal. Does not reset the phase, time stamp, or seed
number.

Contains the following options:

• Use signal type name—

Signal Uses the default signal name.


Name
• Signal name—

Contains the following options:

Result
Displays a preview of the signal to be simulated.
Preview

Inputs/Outputs
• error in (no error) —

Describes error conditions that occur before this node runs.

• Offset —

Specifies the DC offset of the signal. The default is 0. The value you wire to this input overrides
the value you set in the configuration dialog box.

• Phase —

Specifies the initial phase in degrees of the signal. The default is 0. The value you wire to this
input overrides the value you set in the configuration dialog box.

• Amplitude —

990 ni.com
Functions

Specifies the amplitude of the signal. The default is 1. The value you wire to this input overrides
the value you set in the configuration dialog box.

• Duty Cycle (%) —

Specifies the percentage of time a square wave remains high versus low over one period. The
default is 50. The value you wire to this input overrides the value you set in the configuration
dialog box.

• Noise Amplitude —

Specifies the maximum absolute value the signal can have. The default is 0.6. The value you wire
to this input overrides the value you set in the configuration dialog box.

• Standard deviation —

Specifies the standard deviation of the noise you generate. The default is 0.6. The value you wire
to this input overrides the value you set in the configuration dialog box.

• Spectral amplitude —

Specifies the magnitude of the frequency domain components of the simulated signal. The
default is 0.6. The value you wire to this input overrides the value you set in the configuration
dialog box.

• Order —

Specifies the event number of the unit mean Poisson process. The default is 0.6. The value you
wire to this input overrides the value you set in the configuration dialog box.

• Mean —

Specifies the interval of a unit rate Poisson process. The default is 0.6. The value you wire to this
input overrides the value you set in the configuration dialog box.

• Trial probability —

Specifies the probability that a given trial is TRUE. The default is 0.6. The value you wire to this
input overrides the value you set in the configuration dialog box.

• One probability —

Specifies the probability that a given element of the signal is TRUE. The default is 0.6. The value

© National Instruments 991


Functions

you wire to this input overrides the value you set in the configuration dialog box.

• Polynomial Order —

Specifies the order of the modulo-2 primitive polynomial to use to generate the signal. The
default is 0.6. The value you wire to this input overrides the value you set in the configuration
dialog box.

• Exponent —

Specifies the exponent of the inverse-f spectral shape you want. The default is 1. The value you
wire to this input overrides the value you set in the configuration dialog box.

• Trials —

Specifies the number of trials performed for each element of the simulated signal. The default is
1. The value you wire to this input overrides the value you set in the configuration dialog box.

• Reset Signal —

Specifies when to reset the signal. The value you wire to this input overrides the value you set in
the configuration dialog box.

• Seed Number —

Reseeds the noise sample generator when this value is > 0. The default is –1. If seed is 0, the
noise generator does not reseed and resumes producing noise samples as a continuation of the
previous noise sequence. The value you wire to this input overrides the value you set in the
configuration dialog box.

• Frequency —

Specifies the frequency in hertz of the waveform. The default is 10.1. The value you wire to this
input overrides the value you set in the configuration dialog box.

• Signal —

Returns the output signal formatted as dynamic data.

• error out —

Contains error information. This output provides standard error out functionality.

992 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Express VIs\Express VI - Amplitude and


Level Measurements.vi

Components

Specifies the type of noise to add to the waveform. This option is available only when
you place a checkmark in the Add Noise checkbox.

Type of waveform to simulate. You can simulate a sine wave, square wave, sawtooth
wave, triangle wave, or noise (DC).

Continuously simulates the signal. Does not reset the phase, time stamp, or seed
number.

Resets the phase to the phase value and the time stamp to zero. Resets the seed
number to –1.

Indicates the actual number of samples in the waveform when you select Integer
number of cycles.

Indicates the actual frequency of the waveform when you select Integer number of
cycles.

Sets the nearest frequency and Number of samples such that the waveform contains
an integer number of cycles.

Probability that a given trial is TRUE. The default is 0.6. This option is available only
when you select Binomial Noise from the Noise type pull-down menu.

When greater than 0, causes reseeding of the noise sample generator. The default is –1.
LabVIEW maintains the internal seed state independently for each instance of this
reentrant VI. For a specific instance of this VI, if Seed number is less than or equal to 0,
LabVIEW does not reseed the noise generator, and the noise generator resumes
producing noise samples as a continuation of the previous noise sequence.

© National Instruments 993


Functions

Maximum absolute value the signal can have. The default is 0.6. This option is
available only when you select Uniform White Noise or Inverse F Noise from the Noise
type pull-down menu.

Adds noise to the simulated waveform.

Simulates the signal as quickly as the system allows.

Simulates an acquisition rate comparable to an actual acquisition rate.

Displays the timestamp in terms of time elapsed since 12:00 a.m., Friday, January 1,
1904, Universal Time [01-01-1904 00:00:00].

Displays the timestamp in terms of seconds starting from zero. For example, 100 in
relative time equals 1 minute and 40 seconds.

Sets the Number of samples to be one-tenth of Samples per second (Hz).

Contains the following options:

Percentage of time a square wave remains high versus low over one period. The
default is 50.

DC offset of the signal. The default is 0.

Initial phase in degrees of the waveform. The default is 0.

Amplitude of the waveform. The default is 1.

Frequency in hertz of the waveform. The default is 10.1.

Sampling rate in samples per second. The default is 1000.

Uses the default signal name.

Displays the default signal name when you place a checkmark in the Use signal type
name checkbox.

Number of samples in the signal. The default is 100.

994 ni.com
Functions

Number of samples in the signal. The default is 100.

Displays a preview of the signal to be simulated.

Simulate Arbitrary Signal


Simulates a signal that you define.

Dialog Box Options

Option Description
Contains the following options:

• Define Signal—

Displays the Define Signal dialog box, which you use to generate an arbitrary
signal.

• Start over when end of signal is reached—

Continuously simulates the signal you defined.


Signal
Specifications ◦ X values repeat (0, 1, 2, 0, 1, 2)—

Repeats the x values when you select Start over when end of signal is
reached.

◦ X values continue (0, 1, 2, 3, 4, 5)—

Sequentially increments the x values when you select Start over when
end of signal is reached.

Signal
Contains the following options:
Generation

© National Instruments 995


Functions

Option Description

• One point per iteration—

Simulates one point per iteration.

• Entire signal each iteration—

Simulates the entire signal each iteration.

• One defined Y point per iteration (no interpolation)—

Simulates one defined Y point per iteration without using interpolation.

Signal Name Specifies the name of the signal to display on the block diagram.

Displays a preview of the signal to be simulated.

• Number of points—
Result Preview
Displays the number of data points in the signal you defined in the Define
Signal dialog box.

Inputs/Outputs
• Reset —

Controls the initialization of the internal state of the VI. The default is FALSE.

• Next Value —

Specifies the next value of the signal. The default is TRUE. If FALSE, the Express VI outputs the
same value for each iteration.

• error in (no error) —

Describes error conditions that occur before this node runs.

• Signal —

996 ni.com
Functions

Returns the output signal formatted as dynamic data.

• error out —

Contains error information. This output provides standard error out functionality.

• Data Valid —

Indicates whether the data is valid.

Components

Specifies the name of the signal to display on the block diagram.

Displays the Define Signal dialog box, which you use to generate an arbitrary signal.

Displays the number of data points in the signal you defined in the Define Signal dialog
box.

Sequentially increments the x values when you select Start over when end of signal is
reached.

Repeats the x values when you select Start over when end of signal is reached.

Continuously simulates the signal you defined.

Simulates the entire signal each iteration.

Simulates one point per iteration.

Simulates one defined Y point per iteration without using interpolation.

Specifies the name of the signal to display on the block diagram.

Displays a preview of the signal to be simulated.

© National Instruments 997


Functions

Waveform Measurements

Use the Waveform Measurements VIs to perform common time and frequency domain
measurements, such as DC, RMS, Tone Frequency/Amplitude/Phase, Harmonic
Distortion, SINAD, and Averaged FFT Measurements.

Note The Waveform Measurements VIs presently do not accept waveforms


that contain complex data.

The VIs on this palette can return waveform error codes. In addition, the VIs on this
palette return an error if an input waveform has a dt less than or equal to zero.

Palette Object Description

Basic Calculates the DC and RMS values of an input waveform or array of waveforms.
Averaged DC- This VI is similar to the Averaged DC-RMS VI, but this VI returns only one DC value
RMS and one RMS value per input waveform.

Calculates the DC and RMS values of an input waveform or array of waveforms.


Averaged DC-
This VI is similar to the Basic Averaged DC-RMS VI, but this VI gives more precise
RMS
control over the individual DC and RMS calculations.

Returns the average and RMS levels of a selected cycle of a periodic waveform or
Cycle Average
an array of periodic waveforms. Wire data to the signal in input to determine the
and RMS
polymorphic instance to use or manually select the instance.

Waveform Use the Waveform Monitoring VIs to analyze the waveforms for trigger points, to
Monitoring search for peaks, and to perform limit mask testing.

Transition
Accepts an input signal of a single waveform or an array of waveforms and
Measurements

998 ni.com
Functions

Palette Object Description

measures the transition duration (rise or fall time), slew rate, undershoot, and
overshoot of a selected positive or negative transition in each waveform. Wire data
to the signal in input to determine the polymorphic instance to use or manually
select the instance.

Accepts a periodic waveform or an array of periodic waveforms and returns the


Pulse period, pulse duration (pulse width), duty cycle (duty factor), and pulse center of
Measurements a selected pulse and period. Wire data to the signal in input to determine the
polymorphic instance to use or manually select the instance.

Returns the amplitude, high state level, and low state level of a waveform or an
Amplitude
array of waveforms. Wire data to the signal in input to determine the polymorphic
and Levels
instance to use or manually select the instance.

Takes a signal in, finds the single tone with the highest amplitude or searches a
Extract Single specified frequency range, and returns the single tone frequency, amplitude, and
Tone phase. The input signal can be real or complex and single-channel or multichannel.
Information Wire data to the time signal in input to determine the polymorphic instance to use
or manually select the instance.

Extract Returns the frequency, amplitude, and phase for each signal tone whose
Multiple Tone amplitude exceeds a specified threshold. Wire data to the time signal in input to
Information determine the polymorphic instance to use or manually select the instance.

Takes a signal in and performs a full harmonic analysis, including measuring the
Harmonic fundamental frequency tone and harmonics, and returning the fundamental
Distortion frequency, all harmonic amplitude levels, and the total harmonic distortion (THD).
Analyzer Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

SINAD Takes a signal in and performs a full Signal in Noise and Distortion (SINAD)
Analyzer analysis, including measuring the fundamental frequency tone and returning the

© National Instruments 999


Functions

Palette Object Description

fundamental frequency and SINAD level in dB. Wire data to the signal in input to
determine the polymorphic instance to use or manually select the instance.

FFT Power Computes the averaged auto power spectrum of time signal. Wire data to the time
Spectrum and signal input to determine the polymorphic instance to use or manually select the
PSD instance.

Computes the averaged FFT spectrum of time signal. This VI returns the FFT results
FFT Spectrum
as magnitude and phase. Wire data to the time signal input to determine the
(Mag-Phase)
polymorphic instance to use or manually select the instance.

Computes the averaged FFT spectrum of time signal. This VI returns the FFT results
FFT Spectrum
as real and imaginary parts. Wire data to the time signal input to determine the
(Real-Im)
polymorphic instance to use or manually select the instance.

Frequency
Response Computes the frequency response and the coherence based on the input signals.
Function Results are returned as magnitude, phase, and coherence.
(Mag-Phase)
Frequency
Response Computes the frequency response and the coherence based on the input signals.
Function Results are returned as real part, imaginary part, and coherence.
(Real-Im)

Cross
Computes the averaged cross power spectrum of the input signals. Results are
Spectrum
returned as magnitude and phase.
(Mag-Phase)

Cross
Computes the averaged cross power spectrum of the input signals. Results are
Spectrum
returned as real and imaginary parts.
(Real-Im)

Spectral Performs FFT-based spectral measurements, such as the averaged magnitude


Measurements spectrum, power spectrum, and phase spectrum on a signal.

1000 ni.com
Functions

Palette Object Description

Dual Channel Measures the frequency response of the input signals and the coherence based on
Spectral the current and previous input signals. This Express VI returns results such as
Measurement Magnitude, Phase, Coherence, Real, and Imaginary.

Distortion Performs distortion measurements on a signal, such as tone analysis, total


Measurements harmonic distortion (THD), and signal in noise and distortion (SINAD).

Finds the single tone with the highest amplitude or searches a specified frequency
Tone
range to find the single tone with the highest amplitude. You also can find the
Measurements
frequency and phase for a single tone.

Timing and
Performs timing and transition measurements, such as frequency, period, or duty
Transition
cycle, on a signal, usually a pulse.
Measurements

Amplitude
and Level Performs voltage measurements on a signal.
Measurements

Basic Averaged DC-RMS


Calculates the DC and RMS values of an input waveform or array of waveforms. This VI
is similar to the Averaged DC-RMS VI, but this VI returns only one DC value and one
RMS value per input waveform.

Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

• Basic Averaged DC-RMS for 1 Chan VI


• Basic Averaged DC-RMS for N Chan VI

© National Instruments 1001


Functions

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Note The Basic Averaged DC-RMS VI assumes that consecutive data blocks
are continuous. If they are not, the VI returns a warning.

Basic Averaged DC-RMS for 1 Chan VI


Calculates the DC and RMS values of an input waveform or array of waveforms. This VI
is similar to the Averaged DC-RMS VI, but this VI returns only one DC value and one
RMS value per input waveform.

Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• reset —

reset resets the history of your time signal. You typically use reset to reset the exponentially
averaged measurement.

• signal in —

signal in is the input waveform.

• averaging type —

averaging type is the type of averaging used during the measurement. Because this VI computes
one DC and one RMS value per input waveform, the input record length selects the averaging
time. If averaging type is exponential, this VI calculates the DC and RMS values using an
exponentially weighted averaging measurement starting from the previous DC and RMS values.

1002 ni.com
Functions

0 Linear—Averaging time is equal to the record length.


1 Exponential—Time constant is half the record length.

• window —

window is the window to be applied to the time record before DC/RMS computation. LabVIEW
ignores this input if averaging type is exponential.

Rectangular
0
(no window)
1 Hanning
2 Low side lobe

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• DC value —

DC value is the measured DC value in volts if the signal is in volts.

• RMS value —

RMS value is the measured RMS value in volts if the signal is in volts.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns information about your measurement, mainly warnings for
inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

© National Instruments 1003


Functions

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Note The Basic Averaged DC-RMS VI assumes that consecutive data blocks
are continuous. If they are not, the VI returns a warning.

Basic Averaged DC-RMS for N Chan VI


Calculates the DC and RMS values of an input waveform or array of waveforms. This VI
is similar to the Averaged DC-RMS VI, but this VI returns only one DC value and one
RMS value per input waveform.

Note

The multichannel waveform array input should be the result of a


multichannel acquisition where each element of the array of waveforms is a
distinct and separate channel of data.

Inputs/Outputs
• reset —

1004 ni.com
Functions

reset resets the history of your time signal. You typically use reset to reset the exponentially
averaged measurement.

• signals in —

signals in is the array of input waveforms.

• averaging type —

averaging type is the type of averaging used during the measurement. Because this VI computes
one DC and one RMS value per input waveform, the input record length selects the averaging
time. If averaging type is exponential, this VI calculates the DC and RMS values using an
exponentially weighted averaging measurement starting from the previous DC and RMS values.

0 Linear—Averaging time is equal to the record length.


1 Exponential—Time constant is half the record length.

• window —

window is the window to be applied to the time record before DC/RMS computation. LabVIEW
ignores this input if averaging type is exponential.

Rectangular
0
(no window)
1 Hanning
2 Low side lobe

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• DC values —

DC values is an array of the measured DC values.

• RMS values —

RMS values is an array of the measured RMS values.

• error out —

© National Instruments 1005


Functions

error out contains error information. This output provides standard error out functionality.

• measurements info —

measurements info is an array that returns information about your measurement, mainly
warnings for inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Note The Basic Averaged DC-RMS VI assumes that consecutive data blocks
are continuous. If they are not, the VI returns a warning.

Averaged DC-RMS
Calculates the DC and RMS values of an input waveform or array of waveforms. This VI
is similar to the Basic Averaged DC-RMS VI, but this VI gives more precise control over
the individual DC and RMS calculations.

Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

1006 ni.com
Functions

• Averaged DC-RMS for 1 Chan VI


• Averaged DC-RMS for N Chan VI

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Note The Averaged DC-RMS VI assumes that consecutive data blocks are
continuous. If they are not, the VI returns a warning in measurement info,
unless Ignore input start time is enabled.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Advanced DC-RMS Measurement.vi

Averaged DC-RMS for 1 Chan VI


Calculates the DC and RMS values of an input waveform or array of waveforms. This VI
is similar to the Basic Averaged DC-RMS VI, but this VI gives more precise control over
the individual DC and RMS calculations.

Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• reset —

© National Instruments 1007


Functions

reset resets the history of your time signal. You typically use reset to reset the exponentially
averaged measurement.

• signal in —

signal in is the input waveform.

• averaging type —

averaging type is the type of averaging used during the measurement. If averaging type is
exponential, this VI calculates the DC and RMS values using an exponentially weighted averaging
measurement starting from the previous DC and RMS values.

0 Linear—Averaging time is equal to the record length.


1 Exponential—Time constant is half the record length.

• averaging time —

averaging time defines dt of DC value waveform and RMS value waveform in seconds. The
default is –1.00, which corresponds to average time = input block duration.

For linear averaging, each output data point results from performing the averaging process for
the time period specified by averaging time. For exponential averaging, each output data point
results from exponential integration performed for the time period specified by averaging time
using exp. time constant.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging control —

averaging control contains the advanced parameters used to completely control the DC or RMS
measurement.

• window for DC —

window for DC is the window to be applied to the time record before DC computation.
LabVIEW ignores this input if averaging type is exponential.

1008 ni.com
Functions

Rectangular
0
(no window)
1 Hanning
2 Low side lobe

• output function —

output function selects the type of measurements to be performed.

If you need only DC or RMS measurements, selecting these components separately


increases the processing speed.

0 DC only
1 RMS only
2 DC and RMS

• window for RMS —

window for RMS is the window to be applied to the time record before RMS computation.
LabVIEW ignores this input if averaging type is exponential.

Rectangular
0
(no window)
1 Hanning
2 Low side lobe

• exp. time constant —

exp. time constant specifies the time constant (RC) of your DC or RMS measurement.

exp. time constant equals –1.00, which corresponds to a value of input block duration/2.

• Ignore input start time —

Set Ignore input start time to TRUE when you do not want the VI to check for continuity
using t0 values.

• data ready —

© National Instruments 1009


Functions

data ready indicates the DC value waveform and RMS value waveform contain data. A value of
FALSE means the waveforms do not contain data.

• DC value waveform —

DC value waveform indicates DC values of signal in computed over averaging time seconds and
time stamped continuously from the last reset.

• RMS value waveform —

RMS value waveform indicates RMS values of signal in computed over averaging time seconds
and time stamped continuously from the last reset.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns information about your measurement, mainly warnings for
inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Note The Averaged DC-RMS VI assumes that consecutive data blocks are
continuous. If they are not, the VI returns a warning in measurement info,

1010 ni.com
Functions

unless Ignore input start time is enabled.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Advanced DC-RMS Measurement.vi

Averaged DC-RMS for N Chan VI


Calculates the DC and RMS values of an input waveform or array of waveforms. This VI
is similar to the Basic Averaged DC-RMS VI, but this VI gives more precise control over
the individual DC and RMS calculations.

Note

It is assumed that the array of input waveforms is the result of a multichannel


acquisition where each element in the array of waveforms is a distinct and
separate channel of data.

Inputs/Outputs
• reset —

reset resets the history of your time signal. You typically use reset to reset the exponentially
averaged measurement.

• signals in —

© National Instruments 1011


Functions

signals in is the array of input waveforms.

• averaging type —

averaging type is the type of averaging used during the measurement. If averaging type is
exponential, this VI calculates the DC and RMS values using an exponentially weighted averaging
measurement starting from the previous DC and RMS values.

0 Linear—Averaging time is equal to the record length.


1 Exponential—Time constant is half the record length.

• averaging time —

averaging time defines dt of DC value waveform and RMS value waveform in seconds. The
default is –1.00, which corresponds to average time = input block duration.

For linear averaging, each output data point results from performing the averaging process for
the time period specified by averaging time. For exponential averaging, each output data point
results from exponential integration performed for the time period specified by averaging time
using exp. time constant.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging control —

averaging control contains the advanced parameters used to completely control the DC or RMS
measurement.

• window for DC —

window for DC is the window to be applied to the time record before DC computation.
LabVIEW ignores this input if averaging type is exponential.

Rectangular
0
(no window)
1 Hanning
2 Low side lobe

1012 ni.com
Functions

• output function —

output function selects the type of measurements to be performed.

If you need only DC or RMS measurements, selecting these components separately


increases the processing speed.

0 DC only
1 RMS only
2 DC and RMS

• window for RMS —

window for RMS is the window to be applied to the time record before RMS computation.
LabVIEW ignores this input if averaging type is exponential.

Rectangular
0
(no window)
1 Hanning
2 Low side lobe

• exp. time constant —

exp. time constant specifies the time constant (RC) of your DC or RMS measurement.

exp. time constant equals –1.00, which corresponds to a value of input block duration/2.

• Ignore input start time —

Set Ignore input start time to TRUE when you do not want the VI to check for continuity
using t0 values.

• data ready —

data ready indicates the DC value waveform and RMS value waveform contain data. A value of
FALSE means the waveforms do not contain data.

• DC value waveforms —

DC value waveforms is an array of waveforms containing DC values.

© National Instruments 1013


Functions

• RMS value waveforms —

RMS value waveforms is an array of waveforms containing RMS values.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurements info —

measurements info is an array that returns information about your measurement, mainly
warnings for inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Note The Averaged DC-RMS VI assumes that consecutive data blocks are
continuous. If they are not, the VI returns a warning in measurement info,
unless Ignore input start time is enabled.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Advanced DC-RMS Measurement.vi

1014 ni.com
Functions

Cycle Average and RMS


Returns the average and RMS levels of a selected cycle of a periodic waveform or an
array of periodic waveforms. Wire data to the signal in input to determine the
polymorphic instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

• Cycle Average and RMS 1 chan VI


• Cycle Average and RMS N chan VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Cycle Average and RMS 1 chan VI


Returns the average and RMS levels of a selected cycle of a periodic waveform or an
array of periodic waveforms. Wire data to the signal in input to determine the
polymorphic instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with

© National Instruments 1015


Functions

IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,


and Related Waveforms.

Inputs/Outputs
• cycle number (1) —

cycle number specifies the cycle, or period, of the periodic signal on which to perform the
measurement.

• signal in —

signal in is the waveform to measure. Each waveform is required to contain at least cycle
number complete cycles, where a cycle is defined as the interval between two consecutive rising
mid ref level crossings.

• reference levels —

reference levels specifies the high, middle, and low reference levels of a waveform.

LabVIEW uses the reference levels to define the measurement interval of one complete cycle.
The distance between the mid ref level and the high ref level must equal the distance between
the low ref level and the mid ref level. If the two distances are not equal, LabVIEW adjusts either
the high ref level or the low ref level to match the smaller of the two distances. For example, if
you specify a high ref level of 90%, a mid ref level of 50%, and a low ref level of 20%, LabVIEW
uses 80% instead of 90% for the high ref level.

• high ref level —

high ref level specifies the high reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the rising direction, it must cross the high ref
level before the next falling mid ref level crossing can be counted.

1016 ni.com
Functions

• mid ref level —

mid ref level specifies the middle reference level in percent (default) or absolute units.

The interval between consecutive rising mid ref level crossings defines one cycle, or period,
of the waveform. At least one high/low reference level crossing must separate each mid ref
level crossing.

• low ref level —

low ref level specifies the low reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the falling direction, it must cross the low ref
level before the next rising mid ref level crossing can be counted.

• ref units —

ref units specifies whether the high ref level, mid ref level, and low ref level inputs are
interpreted as a percentage (default) of the full range of the waveform or as absolute levels.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• percent level settings —

percent level settings specifies the method LabVIEW uses to determine the high and low state
levels of a waveform.

If you select percent ref units, percent level settings determines the reference levels. Otherwise,
LabVIEW ignores this input.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
0
the upper and lower regions of the waveform. The upper and lower regions of the

© National Instruments 1017


Functions

waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.
Auto select (default)—Determines whether the histogram bins that correspond to the high
and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
2 results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

• histogram size —

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• cycle average —

cycle average is the mean level of one complete period of a periodic input waveform.

The average is computed by the following equation. where i


indicates the waveform samples that fall in the single period specified by cycle number and
numPoints is given by the following equation. numPoints = int(period/dt + .5) where dt is
the time between two samples and int( ) is a function that returns the integer portion of a
floating-point number.

The cycle average of a perfect sine wave is zero, while the average level of the entire waveform
can be nonzero due to partial periods at the boundaries of the waveform.

• cycle RMS —

1018 ni.com
Functions

cycle RMS is the root mean square value of one complete period of a periodic input waveform.

The RMS value is computed by the following equation.

where i indicates the waveform samples that fall in the single period specified by cycle number
and numPoints is given by the following equation. numPoints = int(period/dt + .5) where
dt is the time between two points and int( ) is a function that returns the integer portion of a
floating-point number.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns the measurement cycle interval endpoints and the absolute
reference levels used to define the measurement cycle.

• start time —

start time specifies the time of the rising mid ref level crossing that defines the start of the
measurement interval.

• end time —

end time specifies the time of the rising mid ref level crossing that defines the end of the
measurement interval.

• ref levels —

ref levels returns the three user-defined reference levels of the waveform in absolute units.

LabVIEW uses the reference levels to define the interval of one cycle measurement.

• high ref level —

high ref level returns the high reference level.

• mid ref level —

© National Instruments 1019


Functions

mid ref level returns the middle reference level.

• low ref level —

low ref level returns the low reference level.

• ref units —

ref units is always absolute in measurement info.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Cycle Average and RMS N chan VI


Returns the average and RMS levels of a selected cycle of a periodic waveform or an
array of periodic waveforms. Wire data to the signal in input to determine the
polymorphic instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

1020 ni.com
Functions

Inputs/Outputs
• cycle number (1) —

cycle number specifies the cycle, or period, of the periodic signal on which to perform the
measurement.

• signal(s) in —

signal(s) in is an array of waveforms containing the signals to measure. Each waveform is


required to contain at least cycle number complete cycles, where a cycle is defined as the
interval between two consecutive rising mid ref level crossings.

• reference levels —

reference levels specifies the high, middle, and low reference levels of a waveform.

LabVIEW uses the reference levels to define the measurement interval of one complete cycle.
The distance between the mid ref level and the high ref level must equal the distance between
the low ref level and the mid ref level. If the two distances are not equal, LabVIEW adjusts either
the high ref level or the low ref level to match the smaller of the two distances. For example, if
you specify a high ref level of 90%, a mid ref level of 50%, and a low ref level of 20%, LabVIEW
uses 80% instead of 90% for the high ref level.

• high ref level —

high ref level specifies the high reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the rising direction, it must cross the high ref
level before the next falling mid ref level crossing can be counted.

• mid ref level —

mid ref level specifies the middle reference level in percent (default) or absolute units.

The interval between consecutive rising mid ref level crossings defines one cycle, or period,

© National Instruments 1021


Functions

of the waveform. At least one high/low reference level crossing must separate each mid ref
level crossing.

• low ref level —

low ref level specifies the low reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the falling direction, it must cross the low ref
level before the next rising mid ref level crossing can be counted.

• ref units —

ref units specifies whether the high ref level, mid ref level, and low ref level inputs are
interpreted as a percentage (default) of the full range of the waveform or as absolute levels.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• percent level settings —

percent level settings specifies the method LabVIEW uses to determine the high and low state
levels of a waveform.

If you select percent ref units, percent level settings determines the reference levels. Otherwise,
LabVIEW ignores this input.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
the upper and lower regions of the waveform. The upper and lower regions of the
0
waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.
2 Auto select (default)—Determines whether the histogram bins that correspond to the high

1022 ni.com
Functions

and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

• histogram size —

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• cycle average —

cycle average is an array containing the cycle average of each waveform in signal(s) in. cycle
average is the mean level of one complete period of a periodic input waveform.

The average is computed by the following equation. where i


indicates the waveform samples that fall in the single period specified by cycle number and
numPoints is given by the following equation. numPoints = int(period/dt + .5) where dt is
the time between two samples and int( ) is a function that returns the integer portion of a
floating-point number.

The cycle average of a perfect sine wave is zero, while the average level of the entire waveform
can be nonzero due to partial periods at the boundaries of the waveform.

• cycle RMS —

cycle RMS is an array containing the cycle RMS value for each waveform in signal(s) in. cycle
RMS is the root mean square value of one complete period of a periodic input waveform.

© National Instruments 1023


Functions

The RMS value is computed by the following equation.

where i indicates the waveform samples that fall in the single period specified by cycle number
and numPoints is given by the following equation. numPoints = int(period/dt + .5) where
dt is the time between two points and int( ) is a function that returns the integer portion of a
floating-point number.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info is an array of clusters containing measurement information for each input
waveform.

• start time —

start time specifies the time of the rising mid ref level crossing that defines the start of the
measurement interval.

• end time —

end time specifies the time of the rising mid ref level crossing that defines the end of the
measurement interval.

• ref levels —

ref levels returns the three user-defined reference levels of the waveform in absolute units.

LabVIEW uses the reference levels to define the interval of one cycle measurement.

• high ref level —

high ref level returns the high reference level.

• mid ref level —

mid ref level returns the middle reference level.

• low ref level —

1024 ni.com
Functions

low ref level returns the low reference level.

• ref units —

ref units is always absolute in measurement info.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Waveform Monitoring
Use the Waveform Monitoring VIs to analyze the waveforms for trigger points, to search
for peaks, and to perform limit mask testing.

Note The VIs on this palette return an error if an input waveform has a dt
less than or equal to zero.

Note The Waveform Monitoring VIs presently do not accept waveforms that
contain complex data.

The VIs on this palette can return waveform error codes.

© National Instruments 1025


Functions

Palette
Description
Object

Performs limit testing on waveform or cluster input data. The VI compares signal in
with upper limit and lower limit and ignores any limit input that is not wired. You
Limit Testing can wire output values to a graph to view the limits, signal, and failures. Wire data to
the signal in input to determine the polymorphic instance to use or manually select
the instance.

Creates continuous or segmented masks in the time domain or in the frequency


Limit domain. You can use different instances of this VI to create multiple limits. Wire data
Specification to the Specification Cluster input to determine the polymorphic instance to use or
manually select the instance.

Creates a continuous or segmented mask in the time domain or in the frequency


Limit
domain. You can use different instances of this VI to create multiple limits. Wire data
Specification
to the Specification Cluster input to determine the polymorphic instance to use or
By Formula
manually select the instance.

Waveform Finds the locations, amplitudes, and second derivatives of peaks and valleys in
Peak Signal In. Wire data to the Signal In input to determine the polymorphic instance to
Detection use or manually select the instance.

Finds the first level-crossing location in a waveform. You can retrieve the trigger
Basic Level
location as an index or as a time. The trigger conditions are specified in terms of
Trigger
threshold level, slope, and hysteresis. Wire data to the signal in input to determine
Detection
the polymorphic instance to use or manually select the instance.

Mask and
Performs limit testing on Signals.
Limit Testing

Trigger and
Uses triggering to extract a segment out of a signal. The trigger conditions can be
Gate

1026 ni.com
Functions

Palette
Description
Object

based on a start or stop trigger threshold or can be static. When a trigger condition is
static, the trigger occurs immediately and this Express VI returns a predefined
number of samples.

Limit Testing
Performs limit testing on waveform or cluster input data. The VI compares signal in
with upper limit and lower limit and ignores any limit input that is not wired. You can
wire output values to a graph to view the limits, signal, and failures. Wire data to the
signal in input to determine the polymorphic instance to use or manually select the
instance.

• Limit Testing Time VI


• Limit Testing Frequency VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Limit Testing Measurement.vi
• labview\examples\Signal Processing\Waveform Measurements\
Limit Testing for Unevenly Sampled Data.vi

Limit Testing Time VI


Performs limit testing on waveform or cluster input data. The VI compares signal in
with upper limit and lower limit and ignores any limit input that is not wired. You can
wire output values to a graph to view the limits, signal, and failures. Wire data to the

© National Instruments 1027


Functions

signal in input to determine the polymorphic instance to use or manually select the
instance.

Inputs/Outputs
• output t0 —

output t0 determines the source of start time, t0, of the waveforms for output values.

t0 = limit x0 (default)—Starts with upper limit start time if you define the upper and lower
0
limits.
1 t0 = signal in t0—Starts with signal in start time.

• signal in —

signal in specifies the waveform to test to make sure it lies in the envelope bounded by the
upper and lower limits.

• upper limit —

upper limit specifies the upper boundary of the envelope. The default is Inf.

• x0 —

x0 specifies the minimum value of the x-axis.

• dx —

dx specifies the x-axis interval between points in the input data.

• Y—

Y specifies the y-axis values for the limit.

• lower limit —

1028 ni.com
Functions

lower limit specifies the lower boundary of the envelope. The default is –Inf.

• x0 —

x0 specifies the minimum value of the x-axis.

• dx —

dx specifies the x-axis interval between points in the input data.

• Y—

Y specifies the y-axis values for the limit.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• limit test config —

limit test config specifies the limit-test pass region and whether the limit values are included.

• pass region —

pass region specifies whether you want the test to pass where the signal points fall inside
the limits or outside the limits.

0 Inside limits—lower limit < signal in < upper limit.


Outside limits—signal in does not fall within the area defined by lower limit and upper
1
limit.

• include UL —

include UL specifies whether you want the test to pass where the signal points fall on upper
limit. The default is TRUE.

• include LL —

include LL specifies whether you want the test to pass where the signal points fall on lower

© National Instruments 1029


Functions

limit. The default is TRUE.

• failures —

failures returns the locations of failed test points.

• x values —

x values returns the x-value locations of failed test points.

• y values —

y values returns the y-value locations of failed test points.

• test passed? —

test passed? indicates the result of limit mask testing. If TRUE, the signal is less than or equal to
upper limit and greater than or equal to lower limit and the limit testing passed. If FALSE, the
limit testing did not pass.

• test results —

test results returns the results of the limit testing at each data point. The VI returns TRUE if the
data point is less than or equal to upper limit and greater than or equal to lower limit.

• output values —

output values contains the upper limit and lower limit, the signal, and the failures. You can wire
this output to a graph to view the values.

The first element in the array is the input signal. The x0 and dx values in this waveform are
changed so that it can be easily plotted with the upper and lower limits. The second element in
the array is the failure waveform. The failure waveform contains NaN at points where the limit
test passes and contains the input signal where the limit test fails. The third and fourth elements
of the array are the upper and lower boundaries, respectively.

• error out —

error out contains error information. This output provides standard error out functionality.

• clearance —

1030 ni.com
Functions

clearance returns distance measures between signal in and upper limit and lower limit.

• clearance UL —

clearance UL is the minimum distance between signal in and upper limit (UL). If the signal
points fail at any point along upper limit, clearance UL is set to zero. When clearance UL
returns Inf, upper limit was not defined, so the signal was not tested against it. You can
interpret Inf as passing upper limit with maximum clearance.

• clearance LL —

clearance LL is the minimum distance between signal in and lower limit (LL). If the signal
points fail at any point along lower limit, clearance LL is set to zero. When clearance LL
returns Inf, lower limit was not defined, so the signal was not tested against it. You can
interpret Inf as passing lower limit with maximum clearance.

• min clearance —

min clearance is the minimum, overall distance between signal in and the limits. min
clearance is the minimum of clearance UL and clearance LL. If the signal fails the limit test
at any point, min clearance is set to zero. When min clearance returns Inf, neither upper
limit nor lower limit were defined, so the signal was not tested against them. You can
interpret Inf as passing both upper limit and lower limit with maximum clearance.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Limit Testing Measurement.vi
• labview\examples\Signal Processing\Waveform Measurements\
Limit Testing for Unevenly Sampled Data.vi

Limit Testing Frequency VI


Performs limit testing on waveform or cluster input data. The VI compares signal in
with upper limit and lower limit and ignores any limit input that is not wired. You can

© National Instruments 1031


Functions

wire output values to a graph to view the limits, signal, and failures. Wire data to the
signal in input to determine the polymorphic instance to use or manually select the
instance.

Inputs/Outputs
• signal in —

signal in contains the signal to test to make sure it lies in the envelope bounded by the upper
and lower limits.

• f0 —

f0 specifies the start frequency, in hertz, of the spectrum.

• df —

df specifies the frequency resolution, in hertz, of the spectrum.

• spectrum —

spectrum is the spectrum of the input signal.

• upper limit —

upper limit specifies the upper boundary of the envelope. The default is Inf.

• x0 —

x0 specifies the minimum value of the x-axis.

• dx —

dx specifies the x-axis interval between points in the input data.

1032 ni.com
Functions

• Y—

Y specifies the y-axis values for the limit.

• lower limit —

lower limit specifies the lower boundary of the envelope. The default is –Inf.

• x0 —

x0 specifies the minimum value of the x-axis.

• dx —

dx specifies the x-axis interval between points in the input data.

• Y—

Y specifies the y-axis values for the limit.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• limit test config —

limit test config specifies the limit-test pass region and whether the limit values are included.

• pass region —

pass region specifies whether you want the test to pass where the signal points fall inside
the limits or outside the limits.

0 Inside limits—lower limit < signal in < upper limit.


Outside limits—signal in does not fall within the area defined by lower limit and upper
1
limit.

• include UL —

© National Instruments 1033


Functions

include UL specifies whether you want the test to pass where the signal points fall on upper
limit. The default is TRUE.

• include LL —

include LL specifies whether you want the test to pass where the signal points fall on lower
limit. The default is TRUE.

• failures —

failures returns the locations of failed test points.

• x values —

x values returns the x-value locations of failed test points.

• y values —

y values returns the y-value locations of failed test points.

• test passed? —

test passed? indicates the result of limit mask testing. If TRUE, the signal is less than or equal to
upper limit and greater than or equal to lower limit and the limit testing passed. If FALSE, the
limit testing did not pass.

• test results —

test results returns the results of the limit testing at each data point. The VI returns TRUE if the
data point is less than or equal to upper limit and greater than or equal to lower limit.

• output values —

output values contains the upper limit and lower limit, the signal, and the failures. You can wire
this output to a graph to view the values.

The first element in the array is the input signal. The x0 and dx values in this waveform are
changed so that it can be easily plotted with the upper and lower limits. The second element in
the array is the failure waveform. The failure waveform contains NaN at points where the limit
test passes and contains the input signal where the limit test fails. The third and fourth elements

1034 ni.com
Functions

of the array are the upper and lower boundaries, respectively.

• x0 —

x0 is the minimum value of the x-axis.

• dx —

dx is the x-axis interval between points in the input data.

• Y—

Y contains the y-axis values for the limit.

• error out —

error out contains error information. This output provides standard error out functionality.

• clearance —

clearance returns distance measures between signal in and upper limit and lower limit.

• clearance UL —

clearance UL is the minimum distance between signal in and upper limit (UL). If the signal
points fail at any point along upper limit, clearance UL is set to zero. When clearance UL
returns Inf, upper limit was not defined, so the signal was not tested against it. You can
interpret Inf as passing upper limit with maximum clearance.

• clearance LL —

clearance LL is the minimum distance between signal in and lower limit (LL). If the signal
points fail at any point along lower limit, clearance LL is set to zero. When clearance LL
returns Inf, lower limit was not defined, so the signal was not tested against it. You can
interpret Inf as passing lower limit with maximum clearance.

• min clearance —

min clearance is the minimum, overall distance between signal in and the limits. min
clearance is the minimum of clearance UL and clearance LL. If the signal fails the limit test
at any point, min clearance is set to zero. When min clearance returns Inf, neither upper

© National Instruments 1035


Functions

limit nor lower limit were defined, so the signal was not tested against them. You can
interpret Inf as passing both upper limit and lower limit with maximum clearance.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Limit Testing Measurement.vi
• labview\examples\Signal Processing\Waveform Measurements\
Limit Testing for Unevenly Sampled Data.vi

Limit Specification
Creates continuous or segmented masks in the time domain or in the frequency
domain. You can use different instances of this VI to create multiple limits. Wire data to
the Specification Cluster input to determine the polymorphic instance to use or
manually select the instance.

• Create Continuous Mask VI


• Create Segmented Mask VI

You specify the y-axis values in terms of numeric values and use this VI with the Limit
Testing VI to do limit testing. Wire the Limit Specification VI and the Limit Testing VI in
either a For Loop or a While Loop. Set Reset to FALSE, unless you want to change the
limit. The following illustration shows the Limit Specification VI and the Limit Testing
VI wired together in a While Loop.

1036 ni.com
Functions

Create Continuous Mask VI


Creates continuous or segmented masks in the time domain or in the frequency
domain. You can use different instances of this VI to create multiple limits. Wire data to
the Specification Cluster input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Reset —

Reset indicates if the VI computes Limit. If TRUE, the VI computes Limit using the values in the
Specification Cluster. If FALSE (default), the VI does not compute Limit. The VI always computes
Limit the first time LabVIEW runs this VI.

• Specification Cluster —

Specification Cluster is a cluster that contains the x-axis and y-axis values at which the limit is
specified.

• X—

X contains the x-axis values for the limit.

• Y—

© National Instruments 1037


Functions

Y contains the numerical y-axis values for the limit.

To specify y-axis values using formulas, use the Limit Specification By Formula VI.

• dx —

dx is the x-axis interval between points in the input data to compare against the limits. The VI
uses this value to interpolate the y-axis data for the limit.

• x0 —

x0 is the starting x-axis value of the input data to compare against the limits. The limit is
undefined for values of x that are smaller than the first element in the input array X.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• Limit —

Limit contains a continuous mask, as defined by Specification Cluster, dx, and x0.

• x0 —

x0 is the starting x-axis value of the limit.

• dx —

dx is the x-axis interval between points in the limit.

• Y—

Y contains the numerical y-axis values for the limit.

• error out —

error out contains error information. This output provides standard error out functionality.

1038 ni.com
Functions

You specify the y-axis values in terms of numeric values and use this VI with the Limit
Testing VI to do limit testing. Wire the Limit Specification VI and the Limit Testing VI in
either a For Loop or a While Loop. Set Reset to FALSE, unless you want to change the
limit. The following illustration shows the Limit Specification VI and the Limit Testing
VI wired together in a While Loop.

Create Segmented Mask VI


Creates continuous or segmented masks in the time domain or in the frequency
domain. You can use different instances of this VI to create multiple limits. Wire data to
the Specification Cluster input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Reset —

Reset indicates if the VI computes Limit. If TRUE, the VI computes Limit using the values in the
Specification Cluster. If FALSE (default), the VI does not compute Limit. The VI always computes
Limit the first time LabVIEW runs this VI.

• Specification Cluster —

Specification Cluster is an array of clusters that contains the x-axis and y-axis values at which
the limit is specified. The ith element in the array defines the ith segment in the segmented
mask.

© National Instruments 1039


Functions

• X—

X contains the x-axis values for the limit.

• Y—

Y contains the numerical y-axis values for the limit.

To specify y-axis values using formulas, use the Limit Specification By Formula VI.

• dx —

dx is the x-axis interval between points in the input data to compare against the limits. The VI
uses this value to interpolate the y-axis data for the limit.

• x0 —

x0 is the starting x-axis value of the input data to compare against the limits. The limit is
undefined for values of x that are smaller than the first element in the input array X.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• Limit —

Limit contains a segmented mask, as defined by Specification Cluster, dx, and x0.

• x0 —

x0 is the starting x-axis value of the limit.

• dx —

dx is the x-axis interval between points in the limit.

• Y—

Y contains the numerical y-axis values for the limit.

• error out —

1040 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

You specify the y-axis values in terms of numeric values and use this VI with the Limit
Testing VI to do limit testing. Wire the Limit Specification VI and the Limit Testing VI in
either a For Loop or a While Loop. Set Reset to FALSE, unless you want to change the
limit. The following illustration shows the Limit Specification VI and the Limit Testing
VI wired together in a While Loop.

Limit Specification By Formula


Creates a continuous or segmented mask in the time domain or in the frequency
domain. You can use different instances of this VI to create multiple limits. Wire data to
the Specification Cluster input to determine the polymorphic instance to use or
manually select the instance.

• Create Continuous Mask using Formula VI


• Create Segmented Mask using Formula VI

You specify the y-axis values in terms of formulas and use this VI with the Limit Testing
VI to do limit testing. Wire the Limit Specification by Formula VI and the Limit Testing VI
in either a For Loop or a While Loop. Set Reset to FALSE, unless you want to change the
limit. The following illustration shows the Limit Specification by Formula VI and the
Limit Testing VI wired together in a While Loop.

© National Instruments 1041


Functions

Create Continuous Mask using Formula VI


Creates a continuous or segmented mask in the time domain or in the frequency
domain. You can use different instances of this VI to create multiple limits. Wire data to
the Specification Cluster input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Reset —

Reset indicates if the VI computes Limit. If TRUE, the VI computes Limit using the values in the
Specification Cluster. If FALSE (default), the VI does not compute Limit. The VI always computes
Limit the first time LabVIEW runs this VI.

• Specification Cluster —

Specification Cluster is a cluster that contains the x-axis and y-axis values at which the limit is
specified.

• X—

X contains the x-axis values for the limit.

• Y—

1042 ni.com
Functions

Y contains the y-axis values described by formulas, such as -92.5+21.5*log2(x) where x is


the x-axis value. You can enter only single-variable formulas. You also can use constants,
such as -95.0, for the y-axis values.

• dx —

dx is the x-axis interval between points in the input data to compare against the limits. The VI
uses this value to interpolate the y-axis data for the limit.

• x0 —

x0 is the starting x-axis value of the input data to compare against the limits. The limit is
undefined for values of x that are smaller than the first element in the input array X.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• Limit —

Limit contains a continuous mask, as defined by Specification Cluster, dx, and x0.

• x0 —

x0 is the starting x-axis value of the limit.

• dx —

dx is the x-axis interval between points in the limit.

• Y—

Y contains the numerical y-axis values for the limit.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 1043


Functions

You specify the y-axis values in terms of formulas and use this VI with the Limit Testing
VI to do limit testing. Wire the Limit Specification by Formula VI and the Limit Testing VI
in either a For Loop or a While Loop. Set Reset to FALSE, unless you want to change the
limit. The following illustration shows the Limit Specification by Formula VI and the
Limit Testing VI wired together in a While Loop.

Create Segmented Mask using Formula VI


Creates a continuous or segmented mask in the time domain or in the frequency
domain. You can use different instances of this VI to create multiple limits. Wire data to
the Specification Cluster input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• Reset —

Reset indicates if the VI computes Limit. If TRUE, the VI computes Limit using the values in the
Specification Cluster. If FALSE (default), the VI does not compute Limit. The VI always computes
Limit the first time LabVIEW runs this VI.

• Specification Cluster —

Specification Cluster is an array of clusters that contains the x-axis and y-axis values at which
the limit is specified. The ith element in the array defines the ith segment in the segmented
mask.

1044 ni.com
Functions

• X—

X contains the x-axis values for the limit.

• Y—

Y contains the y-axis values described by formulas, such as -92.5+21.5*log2(x) where x is


the x-axis value. You can enter only single-variable formulas. You also can use constants,
such as -95.0, for the y-axis values.

• dx —

dx is the x-axis interval between points in the input data to compare against the limits. The VI
uses this value to interpolate the y-axis data for the limit.

• x0 —

x0 is the starting x-axis value of the input data to compare against the limits. The limit is
undefined for values of x that are smaller than the first element in the input array X.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• Limit —

Limit contains a segmented mask, as defined by Specification Cluster, dx, and x0.

• x0 —

x0 is the starting x-axis value of the limit.

• dx —

dx is the x-axis interval between points in the limit.

• Y—

Y contains the numerical y-axis values for the limit.

• error out —

© National Instruments 1045


Functions

error out contains error information. This output provides standard error out functionality.

You specify the y-axis values in terms of formulas and use this VI with the Limit Testing
VI to do limit testing. Wire the Limit Specification by Formula VI and the Limit Testing VI
in either a For Loop or a While Loop. Set Reset to FALSE, unless you want to change the
limit. The following illustration shows the Limit Specification by Formula VI and the
Limit Testing VI wired together in a While Loop.

Waveform Peak Detection


Finds the locations, amplitudes, and second derivatives of peaks and valleys in Signal
In. Wire data to the Signal In input to determine the polymorphic instance to use or
manually select the instance.

This VI is similar to the Peak Detector VI.

• Waveform Peak Detection for 1 Chan VI


• Waveform Peak Detection for N Chan VI

Refer to the support document at ni.com for more information about peak detection
using LabVIEW.

Waveform Peak Detection for 1 Chan VI


Finds the locations, amplitudes, and second derivatives of peaks and valleys in Signal

1046 ni.com
Functions

In. Wire data to the Signal In input to determine the polymorphic instance to use or
manually select the instance.

This VI is similar to the Peak Detector VI.

Inputs/Outputs
• peaks/valleys —

peaks/valleys indicates whether to find peaks or valleys.

0 Peaks
1 Valleys

• Signal In —

Signal In contains the waveform in which to find peaks or valleys.

• threshold —

threshold instructs the VI to ignore peaks and valleys that are too small. The VI ignores peaks if
the fitted amplitude is less than threshold. The VI ignores valleys if the fitted trough is greater
than threshold.

• width —

width specifies the number of consecutive data points to use in the quadratic least squares fit.
The value should be no more than about 1/2 of the half-width of the peak/valley and can be
much smaller (but > 2) for noise-free data. Large widths can reduce the apparent amplitude of
peaks and shift the apparent location. For noisy data, this modification is not important because
the noise obscures the actual peak.

• error in —

© National Instruments 1047


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• initialize (T) —

initialize, when TRUE (default), causes the VI to process the first block of data. The VI requires
some internal setup that must be done at the start for proper operation.

• end of data (T) —

end of data (T), when TRUE (default), causes the VI to process the last block of data. The VI
cleans up internal data after the last block has been processed.

• # found —

# found is the number of peaks/valleys found in the current block of data. # found is the size of
the arrays Locations, Amplitudes, and 2nd Derivatives.

• Locations —

Locations contains the index locations of all peaks or valleys detected in the current block of
data.

Because the peak detection algorithm uses a quadratic fit to find the peaks, it actually
interpolates between the data points. Therefore, the indexes are not integers. In other words,
the peaks found are not necessarily actual points in the input data but may be at fractions of an
index and at amplitudes not found in the input array.

To view the locations in terms of time, use the following equation. Time Locations[i] = t0 +
dt*Locations[i]

• Amplitudes —

Amplitudes contains the amplitudes of peaks or valleys found in the current block of data.

Note The Locations and Amplitudes might deviate from actual peaks or valleys for
noisy signals with large dynamic ranges.

• 2nd Derivatives —

2nd Derivatives gives measurements of the second derivative of the amplitude at each of the
peaks or valleys found in the current block of data.

1048 ni.com
Functions

2nd Derivatives gives an approximate measure of the sharpness of each peak or valley. If you are
detecting peaks, these values are all negative. If you are detecting valleys, the values are all
positive.

Note It is assumed that dt, the time difference between samples, is equal to 1.

• error out —

error out contains error information. This output provides standard error out functionality.

Refer to the support document at ni.com for more information about peak detection
using LabVIEW.

Waveform Peak Detection for N Chan VI


Finds the locations, amplitudes, and second derivatives of peaks and valleys in Signal
In. Wire data to the Signal In input to determine the polymorphic instance to use or
manually select the instance.

This VI is similar to the Peak Detector VI.

Inputs/Outputs
• peaks/valleys —

peaks/valleys indicates whether to find peaks or valleys.

0 Peaks
1 Valleys

• Signals In —

© National Instruments 1049


Functions

Signals In contains the waveforms in which to find peaks or valleys.

• threshold —

threshold instructs the VI to ignore peaks and valleys that are too small. The VI ignores peaks if
the fitted amplitude is less than threshold. The VI ignores valleys if the fitted trough is greater
than threshold.

• width —

width specifies the number of consecutive data points to use in the quadratic least squares fit.
The value should be no more than about 1/2 of the half-width of the peak/valley and can be
much smaller (but > 2) for noise-free data. Large widths can reduce the apparent amplitude of
peaks and shift the apparent location. For noisy data, this modification is not important because
the noise obscures the actual peak.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• initialize (T) —

initialize, when TRUE (default), causes the VI to process the first block of data. The VI requires
some internal setup that must be done at the start for proper operation.

• end of data (T) —

end of data (T), when TRUE (default), causes the VI to process the last block of data. The VI
cleans up internal data after the last block has been processed.

• # found —

# found is the number of peaks/valleys found in the current block of data. # found is the size of
the arrays Locations, Amplitudes, and 2nd Derivatives.

• Locations —

Locations contains the index locations of all peaks or valleys detected in the current block of
data for each waveform.

• Locations —

1050 ni.com
Functions

Locations contains the index locations of all peaks or valleys detected in the current block
of data.

Because the peak detection algorithm uses a quadratic fit to find the peaks, it actually
interpolates between the data points. Therefore, the indexes are not integers. In other
words, the peaks found are not necessarily actual points in the input data but may be at
fractions of an index and at amplitudes not found in the input array.

To view the locations in terms of time, use the following equation. Time Locations[i] = t0 +
dt*Locations[i]

• Amplitudes —

Amplitudes contains the amplitudes of peaks or valleys found in the current block of data for
each waveform.

• Amplitudes —

Amplitudes contains the amplitudes of peaks or valleys found in the current block of data.

Note The Locations and Amplitudes might deviate from actual peaks or valleys
for noisy signals with large dynamic ranges.

• 2nd Derivatives —

2nd Derivatives gives measurements of the second derivative of the amplitude at each of the
peaks or valleys found in the current block of data for each waveform.

• 2nd Derivatives —

2nd Derivatives gives measurements of the second derivative of the amplitude at each of
the peaks or valleys found in the current block of data.

2nd Derivatives gives an approximate measure of the sharpness of each peak or valley. If
you are detecting peaks, these values are all negative. If you are detecting valleys, the
values are all positive.

© National Instruments 1051


Functions

Note It is assumed that dt, the time difference between samples, is equal to 1.

• error out —

error out contains error information. This output provides standard error out functionality.

Refer to the support document at ni.com for more information about peak detection
using LabVIEW.

Basic Level Trigger Detection


Finds the first level-crossing location in a waveform. You can retrieve the trigger
location as an index or as a time. The trigger conditions are specified in terms of
threshold level, slope, and hysteresis. Wire data to the signal in input to determine
the polymorphic instance to use or manually select the instance.

Note Do not use the single-channel version of this VI for continuous


multiple-channel processing.

• Trigger Detection for 1 Channel VI


• Trigger Detection for N Channel VI

This VI can perform single-channel measurements in both one-shot mode (single call)
and continuous mode (multiple calls with history). It also can perform multichannel
measurements in both one-shot mode and continuous mode. If you want to make
multiple-channel measurements in continuous mode, you either must use the
multichannel version of this VI or use one instance of this VI per channel. This VI
detects only the first trigger for each channel.

The single-channel version of this VI is intended primarily for continuous processing of

1052 ni.com
Functions

a single channel. Generalizing this behavior to the multichannel case, typically by


using this single-channel VI in a For Loop to continuously process multiple channels by
indexing an array of waveforms, is a misuse of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling this VI to process another channel without clearing the history,
using reset or restart averaging, results in an unexpected behavior of this VI because
the internal state information is passed from one channel to another.

LabVIEW uses the hysteresis to prevent noise from causing a false trigger. For a rising
edge slope, the signal must pass below level – hysteresis before a trigger level
crossing is detected. For a falling edge slope, the signal must pass above level +
hysteresis before a trigger level crossing is detected. The following graph shows how
LabVIEW uses the hysteresis.

In the previous graph, the white line is the input signal. If the level is 0.5, and the
hysteresis is 0.0, LabVIEW returns the green line that represents the false trigger
caused by the noise. If the hysteresis is 0.15, LabVIEW returns the red line at
approximately 0.125s that represents the valid trigger.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Basic Level Triggering of Waveforms.vi

© National Instruments 1053


Functions

Trigger Detection for 1 Channel VI


Finds the first level-crossing location in a waveform. You can retrieve the trigger
location as an index or as a time. The trigger conditions are specified in terms of
threshold level, slope, and hysteresis. Wire data to the signal in input to determine
the polymorphic instance to use or manually select the instance.

Note Do not use the single-channel version of this VI for continuous


multiple-channel processing.

Inputs/Outputs
• reset —

reset specifies whether the history, or internal state, of the VI has to be reset. The default is
FALSE. The internal state contains the final state of the input signal. The VI uses this as the initial
state the next time LabVIEW calls the VI.

• signal in —

signal in contains the signal in which to detect a trigger.

• level —

level specifies the threshold value signal in must cross before a trigger is detected. The default is
0.

• hysteresis —

hysteresis specifies the amount above or below level through which signal in must pass before
a trigger level crossing is detected. The default is 0.

1054 ni.com
Functions

Trigger hysteresis is used to prevent noise from causing a false trigger. For a rising edge trigger
slope, the signal must pass below level – hysteresis before a trigger level crossing is detected.
For a falling edge trigger slope, the signal must pass above level + hysteresis before a trigger
level crossing is detected.

• location mode —

location mode specifies whether you want to retrieve the trigger location as an index into the Y-
array of the waveform or as a point in time in seconds.

0 Index (default)—Retrieves the trigger location in terms of an array index.


Time—Retrieves the trigger location in terms of time in seconds. Time is computed by the
following equation: time = t0 + (index*dt), where t0 and dt are contained in signal in. Use the
1
To Time Stamp Function to convert this number to a time stamp data type with a time and date
format.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• trigger slope —

trigger slope specifies whether a trigger is detected as signal in crosses level on a rising edge or
a falling edge

0 Falling Edge—The VI detects a trigger on the falling edge, or negative slope.


1 Rising Edge (default)—The VI detects a trigger on the rising edge, or positive slope.

• trigger location —

trigger location contains the index or time, depending on the location mode setting, of the
detected trigger. If the location mode is in Time mode and you do not want the trigger location
value to appear in seconds on the front panel, wire the trigger location to a time stamp.

• trigger detected? —

trigger detected? indicates whether the VI detects a valid trigger. If trigger detected? is TRUE,
the VI detects a valid trigger.

• error out —

© National Instruments 1055


Functions

error out contains error information. This output provides standard error out functionality.

This VI can perform single-channel measurements in both one-shot mode (single call)
and continuous mode (multiple calls with history). It also can perform multichannel
measurements in both one-shot mode and continuous mode. If you want to make
multiple-channel measurements in continuous mode, you either must use the
multichannel version of this VI or use one instance of this VI per channel. This VI
detects only the first trigger for each channel.

The single-channel version of this VI is intended primarily for continuous processing of


a single channel. Generalizing this behavior to the multichannel case, typically by
using this single-channel VI in a For Loop to continuously process multiple channels by
indexing an array of waveforms, is a misuse of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling this VI to process another channel without clearing the history,
using reset or restart averaging, results in an unexpected behavior of this VI because
the internal state information is passed from one channel to another.

LabVIEW uses the hysteresis to prevent noise from causing a false trigger. For a rising
edge slope, the signal must pass below level – hysteresis before a trigger level
crossing is detected. For a falling edge slope, the signal must pass above level +
hysteresis before a trigger level crossing is detected. The following graph shows how
LabVIEW uses the hysteresis.

In the previous graph, the white line is the input signal. If the level is 0.5, and the
hysteresis is 0.0, LabVIEW returns the green line that represents the false trigger

1056 ni.com
Functions

caused by the noise. If the hysteresis is 0.15, LabVIEW returns the red line at
approximately 0.125s that represents the valid trigger.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Basic Level Triggering of Waveforms.vi

Trigger Detection for N Channel VI


Finds the first level-crossing location in a waveform. You can retrieve the trigger
location as an index or as a time. The trigger conditions are specified in terms of
threshold level, slope, and hysteresis. Wire data to the signal in input to determine
the polymorphic instance to use or manually select the instance.

Note Do not use the single-channel version of this VI for continuous


multiple-channel processing.

Inputs/Outputs
• reset —

reset specifies whether the history, or internal state, of the VI has to be reset. The default is
FALSE. The internal state contains the final state of the input signal. The VI uses this as the initial
state the next time LabVIEW calls the VI.

• signal in —

© National Instruments 1057


Functions

signal in contains the signals in which to detect triggers.

• level —

level specifies the threshold value that each signal contained in signal in must cross before a
trigger is detected. The default is 0.

• hysteresis —

hysteresis specifies the amount above or below level through which each signal contained in
signal in must pass before a trigger level crossing is detected. The default is 0.

Trigger hysteresis is used to prevent noise from causing a false trigger. For a rising edge slope,
the signal must pass below level – hysteresis before a trigger level crossing is detected. For a
falling edge slope, the signal must pass above level + hysteresis before a trigger level crossing is
detected.

• location mode —

location mode specifies whether you want to retrieve the trigger location as an index into the Y-
array of the waveform or as a point in time in seconds.

0 Index (default)—Retrieves the trigger location in terms of an array index.


Time—Retrieves the trigger location in terms of time in seconds. Time is computed by the
following equation: time = t0 + (index*dt), where t0 and dt are contained in signal in. Use the
1
To Time Stamp Function to convert this number to a time stamp data type with a time and date
format.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• trigger slope —

trigger slope specifies whether a trigger is detected on a rising edge or a falling edge as each
signal contained in signal in crosses level.

0 Falling Edge—The VI detects a trigger on the falling edge, or negative slope.


1 Rising Edge (default)—The VI detects a trigger on the rising edge, or positive slope.

• trigger locations —

1058 ni.com
Functions

trigger locations contain the index or time value, depending on the location mode setting, of
the detected trigger for each waveform.

• trigger detected? —

trigger detected? indicates whether the VI detects a valid trigger for each signal.

• error out —

error out contains error information. This output provides standard error out functionality.

This VI can perform single-channel measurements in both one-shot mode (single call)
and continuous mode (multiple calls with history). It also can perform multichannel
measurements in both one-shot mode and continuous mode. If you want to make
multiple-channel measurements in continuous mode, you either must use the
multichannel version of this VI or use one instance of this VI per channel. This VI
detects only the first trigger for each channel.

The single-channel version of this VI is intended primarily for continuous processing of


a single channel. Generalizing this behavior to the multichannel case, typically by
using this single-channel VI in a For Loop to continuously process multiple channels by
indexing an array of waveforms, is a misuse of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling this VI to process another channel without clearing the history,
using reset or restart averaging, results in an unexpected behavior of this VI because
the internal state information is passed from one channel to another.

LabVIEW uses the hysteresis to prevent noise from causing a false trigger. For a rising
edge slope, the signal must pass below level – hysteresis before a trigger level
crossing is detected. For a falling edge slope, the signal must pass above level +
hysteresis before a trigger level crossing is detected. The following graph shows how
LabVIEW uses the hysteresis.

© National Instruments 1059


Functions

In the previous graph, the white line is the input signal. If the level is 0.5, and the
hysteresis is 0.0, LabVIEW returns the green line that represents the false trigger
caused by the noise. If the hysteresis is 0.15, LabVIEW returns the red line at
approximately 0.125s that represents the valid trigger.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Basic Level Triggering of Waveforms.vi

Mask and Limit Testing


Performs limit testing on Signals.

Dialog Box Options

Option Description
Contains the following options:
Upper
Limit • Upper constant—

1060 ni.com
Functions

Option Description

Compares Signals to the value in Upper limit constant. This option is available only
when you place a checkmark in the Upper Limit checkbox.

◦ Upper limit constant—

Specifies the value of the Upper constant. The default is 0. This option is
available only when you place a checkmark in the Upper Limit checkbox and
select the Upper constant option.

• Upper mask—

Compares Signals to the upper limit of a signal from a file or a signal you define. This
option is available only when you place a checkmark in the Upper Limit checkbox.

◦ Define—

Displays the Define Signal dialog box, which you use to set the values for the
signal you want to use for the limit test. This button is available only when you
select Upper Limit and Upper mask or Lower Limit and Lower mask.

• Upper inclusive—

Specifies if you want Pass to return TRUE when points in Signals fall on Upper Limit.
Place a checkmark in the Upper inclusive checkbox to include points falling on
Upper Limit in the points that pass the limit test. This option is available only when
you place a checkmark in the Upper Limit checkbox.

Contains the following options:

• Lower constant—

Compares Signals to the value in Lower limit constant. This option is available only
when you place a checkmark in the Lower Limit checkbox.
Lower
◦ Lower limit constant—
Limit
Specifies the value of the Lower constant. The default is 0. This option is
available only when you place a checkmark in the Lower Limit checkbox and
select the Lower constant option.

• Lower mask—

© National Instruments 1061


Functions

Option Description

Compares Signals to the lower limit of a signal from a file or a signal you define. This
option is available only when you place a checkmark in the Lower Limit checkbox.

◦ Define—

Displays the Define Signal dialog box, which you use to set the values for the
signal you want to use for the limit test. This button is available only when you
select Upper Limit and Upper mask or Lower Limit and Lower mask.

• Lower inclusive—

Specifies if you want Pass to return TRUE when points in Signals fall on Lower Limit.
Place a checkmark in the Lower inclusive checkbox to include points falling on
Lower Limit in the points that pass the limit test. This option is available only when
you place a checkmark in the Lower Limit checkbox.

Displays a preview of the measurement. The Result Preview plot indicates the value of
the selected measurement with a dotted line.

Result If you wire data to the Express VI and run the VI, Result Preview displays real data. If you
Preview close and reopen the Express VI, Result Preview displays sample data until you run the VI
again. If the cutoff frequency values are invalid, Result Preview does not display valid
data.

Inputs/Outputs
• error in —

Describes error conditions that occur before this node runs.

• Signals —

Contains the input signal or signals.

• Lower Limit —

Specifies the lower limit for mask and limit testing. The value you wire to this input overrides the
value you set in the configuration dialog box.

• Upper Constant —

1062 ni.com
Functions

Compares Signals to the value in Upper Constant. The value you wire to this input overrides the
value you set in the configuration dialog box.

• Lower Constant —

Compares Signals to the value in Lower Constant. The value you wire to this input overrides the
value you set in the configuration dialog box.

• Upper Limit —

Specifies the upper limit for mask and limit testing. The value you wire to this input overrides
the value you set in the configuration dialog box.

• Point Evaluation —

Returns the results of the limit testing at each data point. If Point Evaluation is TRUE, the data
point is less than or equal to the upper limit and greater than or equal to the lower limit.

• Tested Signals —

Returns the upper and lower limits, the input signal, and the failures.

• error out —

Contains error information. This output provides standard error out functionality.

• Passed —

Indicates the result of limit testing. If Passed is TRUE, the signal is less than or equal to the upper
limit and greater than or equal to the lower limit.

The Express VI compares Signals with the upper and lower limits you set and returns
the result of the comparison at each data point. The Express VI also returns an array of
waveforms that contains the upper limit and lower limit, the signal, and the failures.

Components

Uses an upper limit for mask and limit testing.

Uses a lower limit for mask and limit testing.

© National Instruments 1063


Functions

Specifies if you want Pass to return TRUE when points in Signals fall on Upper Limit.
Place a checkmark in the Upper inclusive checkbox to include points falling on Upper
Limit in the points that pass the limit test. This option is available only when you place
a checkmark in the Upper Limit checkbox.

Specifies if you want Pass to return TRUE when points in Signals fall on Lower Limit.
Place a checkmark in the Lower inclusive checkbox to include points falling on Lower
Limit in the points that pass the limit test. This option is available only when you place
a checkmark in the Lower Limit checkbox.

Uses a lower limit for mask and limit testing. Contains the following options:

Uses a upper limit for mask and limit testing. Contains the following options:

Specifies the value of the Upper constant. The default is 0. This option is available only
when you place a checkmark in the Upper Limit checkbox and select the Upper
constant option.

Specifies the value of the Lower constant. The default is 0. This option is available only
when you place a checkmark in the Lower Limit checkbox and select the Lower
constant option.

Compares Signals to the value in Upper limit constant. This option is available only
when you place a checkmark in the Upper Limit checkbox.

Compares Signals to the value in Lower limit constant. This option is available only
when you place a checkmark in the Lower Limit checkbox.

Displays the Define Signal dialog box, which you use to set the values for the signal you
want to use for the limit test. This button is available only when you select Upper Limit
and Upper mask or Lower Limit and Lower mask.

Compares Signals to the lower limit of a signal from a file or a signal you define. This
option is available only when you place a checkmark in the Lower Limit checkbox.

Compares Signals to the upper limit of a signal from a file or a signal you define. This
option is available only when you place a checkmark in the Upper Limit checkbox.

Displays a preview of the measurement. The Result Preview plot indicates the value of

1064 ni.com
Functions

the selected measurement with a dotted line.

Trigger and Gate


Uses triggering to extract a segment out of a signal. The trigger conditions can be
based on a start or stop trigger threshold or can be static. When a trigger condition is
static, the trigger occurs immediately and this Express VI returns a predefined number
of samples.

Dialog Box Options

Option Description
Contains the following options:

• Threshold—

Uses a threshold to indicate when to start triggering.

◦ Start sense—

Specifies on what edge of the signal to start taking samples. The options are
Rising edge, Rising or Falling edge, or Falling edge. This option is available only
when you select Threshold.
Start
Trigger
◦ Start level—

Amplitude that the signal must cross in the Start sense direction before the
Express VI starts taking samples. The default is 0. This option is available only
when you select Threshold.

◦ Pre samples—

Specifies the number of samples that occur before the start trigger to return.
The default is 0. This option is available only when you select Threshold.

© National Instruments 1065


Functions

Option Description

• Immediate—

Begins the triggering immediately. The start of the signal is the start trigger.

Contains the following options:

• Number of samples—

Ends the triggering when the Express VI collects Samples.

◦ Samples—

Specifies the number of samples to collect before stopping the trigger. The
default is 1000.

• Threshold—
Stop
Uses a threshold to indicate when to start triggering.
Trigger
◦ Stop sense—

Specifies on what edge of the signal to stop taking samples. The options are
Rising edge, Rising or Falling edge, or Falling edge. This option is available only
when you select Threshold.

◦ Stop level—

Amplitude that the signal must cross in the Stop sense direction before the
Express VI stops taking samples. The default is 0. This option is available only
when you select Threshold.

Contains the following options:

• Trigger channel—

General Specifies the channel to use if the dynamic data type input contains multiple
signals. The default is 0.

• Reset after each trigger found—

1066 ni.com
Functions

Option Description

Resets the trigger conditions after finding each trigger. When you select this option,
the Trigger and Gate Express VI does not buffer data with each iteration of a loop.
Select this checkbox when you have a new data set for each iteration and you want
to find data related only to the first trigger point. Deselect this checkbox when you
want to pass only one set of data into a loop and then call the Trigger and Gate
Express VI in a loop to get all the triggers in the data.

Note When you do not select this option, the Trigger and Gate Express VI
buffers data. In this case, if the Trigger and Gate Express VI is called in a
loop, it can start a backlog of data if there is new data for each loop
(because one set of data can contain several trigger points). Because
there is no reset, it buffers all the data from each loop so that it can find
all the triggers, but all the triggers might not be found.

• Remain triggered after trigger found—

Remains triggered after finding a trigger. This option is available only when you
select the Threshold option in the Start Trigger section.

• Hysteresis—

Specifies the amount above and below Start level or Stop level through which
Signals must pass before a trigger level crossing is detected. The default is 0.

Use trigger hysteresis to prevent noise from causing a false trigger. For a rising edge
Start sense or Stop sense, the signal must pass below Start level or Stop level
minus Hysteresis before detecting a trigger level crossing. For a falling edge Start
sense or Stop sense, the signal must pass above Start level or Stop level plus
Hysteresis before detecting a trigger level crossing.

Contains the following options:

• Automatic number of samples—

Output Specifies that the Express VI returns the portion of the signal that matches the
segment trigger criteria.
size
• Number of output samples—

Specifies the number of samples to include in each output segment. This option is

© National Instruments 1067


Functions

Option Description

available only if the Automatic number of samples checkbox does not contain a
checkmark.

Displays the input signal.

If you wire data to the Express VI and run it, Input Signal displays real data. If you close
and reopen the Express VI, Input Signal displays sample data until you run the Express VI
Input
again.
Signal
• Number of points in the data—

Specifies the number of points in the data. The default is 4400.

Displays a preview of the measurement. The Results Preview plot indicates the value of
the selected measurement with a dotted line.
Results
If you wire data to the Express VI and run the VI, Results Preview displays real data. If you
Preview
close and reopen the Express VI, Results Preview displays sample data until you run the
VI again. If the cutoff frequency values are invalid, Results Preview does not display valid
data.

Inputs/Outputs
• error in (no error) —

Describes error conditions that occur before this node runs.

• Signals —

Contains the input signal or signals.

• Reset —

Controls the initialization of the internal state of the VI. The default is FALSE.

• Data Index —

1068 ni.com
Functions

Contains the index of the detected trigger. If this Express VI is in a loop, wire Data Index to the
iteration terminal of the loop.

• Manual Trigger —

Starts the trigger immediately and overrides the Start Trigger settings you configure. The default
is FALSE.

• Data Available —

Indicates if data is available that meets the requirements of the trigger.

• error out —

Contains error information. This output provides standard error out functionality.

• Previous Signals —

Contains the last triggered output data. If no data meets the requirements of the trigger, this
output contains the most recent segment that meet the requirements of the trigger.

• Triggered Signals —

Returns the resulting segment between Start Trigger and Stop Trigger. If no data meets the
requirements of the trigger, this output returns an empty signal.

Components

Specifies that the Express VI returns the portion of the signal that matches the trigger
criteria.

Resets the trigger conditions after finding each trigger. When you select this option, the
Trigger and Gate Express VI does not buffer data with each iteration of a loop. Select
this checkbox when you have a new data set for each iteration and you want to find
data related only to the first trigger point. Deselect this checkbox when you want to
pass only one set of data into a loop and then call the Trigger and Gate Express VI in a
loop to get all the triggers in the data.

Specifies the number of points in the data. The default is 4400.

© National Instruments 1069


Functions

Displays a preview of the measurement. The Results Preview plot indicates the value
of the selected measurement with a dotted line.

Displays the input signal.

Amplitude that the signal must cross in the Stop sense direction before the Express VI
stops taking samples. The default is 0. This option is available only when you select
Threshold.

Specifies on what edge of the signal to stop taking samples. The options are Rising
edge, Rising or Falling edge, or Falling edge. This option is available only when you
select Threshold.

Uses a threshold to indicate when to start triggering.

Ends the triggering when the Express VI collects Samples.

Specifies the amount above and below Start level or Stop level through which Signals
must pass before a trigger level crossing is detected. The default is 0.

Specifies on what edge of the signal to start taking samples. The options are Rising
edge, Rising or Falling edge, or Falling edge. This option is available only when you
select Threshold.

Uses a threshold to indicate when to stop triggering.

Amplitude that the signal must cross in the Start sense direction before the Express VI
starts taking samples. The default is 0. This option is available only when you select
Threshold.

Begins the triggering immediately. The start of the signal is the start trigger.

Remains triggered after finding a trigger. This option is available only when you select
the Threshold option in the Start Trigger section.

Specifies the number of samples to include in each output segment. This option is
available only if the Automatic number of samples checkbox does not contain a
checkmark.

1070 ni.com
Functions

Specifies the channel to use if the dynamic data type input contains multiple signals.
The default is 0.

Specifies the number of samples to collect before stopping the trigger. The default is
1000.

Specifies the number of samples that occur before the start trigger to return. The
default is 0. This option is available only when you select Threshold.

Contains the following options:

Contains the following options:

Transition Measurements
Accepts an input signal of a single waveform or an array of waveforms and measures
the transition duration (rise or fall time), slew rate, undershoot, and overshoot of a
selected positive or negative transition in each waveform. Wire data to the signal in
input to determine the polymorphic instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

• Transition Measurements 1 chan VI


• Transition Measurements N chan VI

The following information applies to the pre-transition and post-transition outputs of


both instances of this VI.

pre-transition

To calculate the pre-transition undershoot and overshoot, LabVIEW searches for a

© National Instruments 1071


Functions

local minimum and maximum in the pre-transition aberration region immediately


preceding the beginning of the transition specified by edge number and polarity. The
pre-transition aberration region is defined as the minimum of 3*(end time – start time)
and (current transition start time – previous transition end time) / 2. If the transition to
measure is the first in the waveform, the interval is defined as the minimum of 3*(end
time – start time) and (start time – beginning of the waveform).

If polarity is falling, LabVIEW calculates the pre-transition undershoot using the


following equation:

If polarity is rising, LabVIEW calculates the pre-transition undershoot using the


following equation:

If polarity is falling, LabVIEW calculates the pre-transition overshoot using the


following equation:

If polarity is rising, LabVIEW calculates the pre-transition overshoot using the


following equation:

Note LabVIEW uses the Histogram method to calculate the state levels and
amplitude, regardless of the method specified by percent level settings.

post-transition

To calculate the post-transition undershoot and overshoot, LabVIEW searches for a


local minimum and maximum in the post-transition aberration region immediately
following the end of the transition specified by edge number and polarity. The post-
transition aberration region is defined as the minimum of 3*(end time – start time) and

1072 ni.com
Functions

(next transition start time – current transition end time) / 2. If the transition to measure
is the last in the waveform, the interval is defined as the minimum of 3*(end time –
start time) and (end of the waveform – end time).

If polarity is falling, LabVIEW calculates the post-transition undershoot using the


following equation:

If polarity is rising, LabVIEW calculates the post-transition undershoot using the


following equation:

If polarity is falling, LabVIEW calculates the post-transition overshoot using the


following equation:

If polarity is rising, LabVIEW calculates the post-transition overshoot using the


following equation:

Note LabVIEW uses the Histogram method to calculate the state levels and
amplitude, regardless of the method specified by percent level settings.

Example Illustrations

The following illustration shows the undershoot and overshoot in a negative single
transition.

© National Instruments 1073


Functions

The following illustration shows the undershoot and overshoot in a positive single
transition.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

1074 ni.com
Functions

Transition Measurements 1 chan VI


Accepts an input signal of a single waveform or an array of waveforms and measures
the transition duration (rise or fall time), slew rate, undershoot, and overshoot of a
selected positive or negative transition in each waveform. Wire data to the signal in
input to determine the polymorphic instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

Inputs/Outputs
• edge number (1) —

edge number specifies the transition to measure.

An edge number of n with rising polarity selected indicates that the VI measures the nth rising
transition it detects in the input waveform.

• signal in —

signal in is the waveform to measure. The waveform is required to contain at least edge number
transitions in the direction specified by polarity.

A rising transition is the interval between adjacent rising low ref level and high ref level
crossings. A falling transition is the interval between adjacent falling high ref level and low ref
level crossings.

• polarity (rising) —

polarity specifies the direction of the transition to measure as rising (default) or falling.

© National Instruments 1075


Functions

• reference levels —

reference levels specifies the high and low reference levels required to determine the transition
interval. mid ref level is not used in transition measurements.

Reference levels provide a means to identify the position in time of the waveform feature
measured.

• high ref level —

high ref level specifies the high reference level of the waveform in percent (default) or
absolute units.

A rising high ref level crossing defines the end of a rising transition and a falling high ref
level crossing defines the beginning of a falling transition.

• mid ref level —

mid ref level specifies the middle reference level in percent (default) or absolute units. mid
ref level is not used in transition measurements.

• low ref level —

low ref level specifies the low reference level of the waveform in percent (default) or
absolute units.

A rising low ref level crossing defines the beginning of a rising transition and a falling low
ref level crossing defines the end of a falling transition.

• ref units —

ref units specifies whether the high ref level, mid ref level, and low ref level inputs are
interpreted as a percentage (default) of the full range of the waveform or as absolute levels.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• percent level settings —

percent level settings specifies the method LabVIEW uses to determine the high and low state
levels of a waveform.

1076 ni.com
Functions

If you select percent ref units, percent level settings determines the reference levels. Otherwise,
LabVIEW ignores this input.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
the upper and lower regions of the waveform. The upper and lower regions of the
0
waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.
Auto select (default)—Determines whether the histogram bins that correspond to the high
and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
2 results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

• histogram size —

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• slope —

slope is a measure of the rate of change of the signal in a transition region between high ref
level and low ref level.

© National Instruments 1077


Functions

slope is given by the following equation. where transition


duration is the transition duration for either rising or falling transition polarity and high ref level
and low ref level are in absolute units.

• transition duration —

transition duration is the time span from when the waveform crosses the low ref level until it
crosses the high ref level in seconds for a rising transition polarity.

The measurement starts at the left edge of the waveform and finds all low ref level crossings
preceding the first high ref level crossing. The final low ref level crossing is used in the
calculation. A rising polarity transition duration is known as rise time, and a falling polarity
transition duration is known as fall time, as shown in the following example:

• pre-transition —

pre-transition contains the undershoot and overshoot for the waveform in signal in.

Refer to the Details section for more information about the pre-transition output.

• undershoot (%) —

undershoot measures the height of the local minimum preceding a rising or falling
transition, which depends on the polarity you specify. Undershoot measures the height as a
percentage of the histogram-based amplitude of the signal.

• overshoot (%) —

overshoot measures the height of the local maximum preceding a rising or falling

1078 ni.com
Functions

transition, which depends on the polarity you specify. Overshoot measures the height as a
percentage of the histogram-based amplitude of the signal.

• post-transition —

post-transition contains the undershoot and overshoot for the waveform in signal in.

Refer to the Details section for more information about the post-transition output.

• undershoot (%) —

undershoot measures the height of the local minimum following a rising or falling, as set by
polarity, transition as a percentage of the histogram-based amplitude of the signal.

• overshoot (%) —

overshoot measures the height of the local maximum following a rising or falling, as set by
polarity, transition as a percentage of the histogram-based amplitude of the signal.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns the transition interval end points and the absolute reference levels
used to define the transition.

• start time —

start time specifies the time of the rising (falling) low (high) ref level crossing that defines
the start of the transition to be measured.

• end time —

end time specifies the time of the rising (falling) high (low) ref level crossing that defines the
end of the transition to be measured.

• ref levels —

© National Instruments 1079


Functions

ref levels returns the three user-defined reference levels of the waveform in absolute units.

LabVIEW uses the reference levels to define the interval of one cycle measurement.

• high ref level —

high ref level returns the high reference level.

• mid ref level —

mid ref level returns the middle reference level.

• low ref level —

low ref level returns the low reference level.

• ref units —

ref units is always absolute in measurement info.

The following information applies to the pre-transition and post-transition outputs of


both instances of this VI.

pre-transition

To calculate the pre-transition undershoot and overshoot, LabVIEW searches for a


local minimum and maximum in the pre-transition aberration region immediately
preceding the beginning of the transition specified by edge number and polarity. The
pre-transition aberration region is defined as the minimum of 3*(end time – start time)
and (current transition start time – previous transition end time) / 2. If the transition to
measure is the first in the waveform, the interval is defined as the minimum of 3*(end
time – start time) and (start time – beginning of the waveform).

If polarity is falling, LabVIEW calculates the pre-transition undershoot using the


following equation:

1080 ni.com
Functions

If polarity is rising, LabVIEW calculates the pre-transition undershoot using the


following equation:

If polarity is falling, LabVIEW calculates the pre-transition overshoot using the


following equation:

If polarity is rising, LabVIEW calculates the pre-transition overshoot using the


following equation:

Note LabVIEW uses the Histogram method to calculate the state levels and
amplitude, regardless of the method specified by percent level settings.

post-transition

To calculate the post-transition undershoot and overshoot, LabVIEW searches for a


local minimum and maximum in the post-transition aberration region immediately
following the end of the transition specified by edge number and polarity. The post-
transition aberration region is defined as the minimum of 3*(end time – start time) and
(next transition start time – current transition end time) / 2. If the transition to measure
is the last in the waveform, the interval is defined as the minimum of 3*(end time –
start time) and (end of the waveform – end time).

If polarity is falling, LabVIEW calculates the post-transition undershoot using the


following equation:

If polarity is rising, LabVIEW calculates the post-transition undershoot using the

© National Instruments 1081


Functions

following equation:

If polarity is falling, LabVIEW calculates the post-transition overshoot using the


following equation:

If polarity is rising, LabVIEW calculates the post-transition overshoot using the


following equation:

Note LabVIEW uses the Histogram method to calculate the state levels and
amplitude, regardless of the method specified by percent level settings.

Example Illustrations

The following illustration shows the undershoot and overshoot in a negative single
transition.

The following illustration shows the undershoot and overshoot in a positive single
transition.

1082 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Transition Measurements N chan VI


Accepts an input signal of a single waveform or an array of waveforms and measures
the transition duration (rise or fall time), slew rate, undershoot, and overshoot of a
selected positive or negative transition in each waveform. Wire data to the signal in
input to determine the polymorphic instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

© National Instruments 1083


Functions

Inputs/Outputs
• edge number (1) —

edge number specifies the transition to measure.

An edge number of n with rising polarity selected indicates that the VI measures the nth rising
transition it detects in the input waveform.

• signal(s) in —

signal(s) in is the array of waveforms to measure. The waveform is required to contain at least
edge number transitions in the direction specified by polarity.

A rising transition is the interval between adjacent rising low ref level and high ref level
crossings. A falling transition is the interval between adjacent falling high ref level and low ref
level crossings.

• polarity (rising) —

polarity specifies the direction of the transition to measure as rising (default) or falling.

• reference levels —

reference levels specifies the high and low reference levels required to determine the transition
interval. mid ref level is not used in transition measurements.

Reference levels provide a means to identify the position in time of the waveform feature
measured.

• high ref level —

high ref level specifies the high reference level of the waveform in percent (default) or
absolute units.

A rising high ref level crossing defines the end of a rising transition and a falling high ref
level crossing defines the beginning of a falling transition.

1084 ni.com
Functions

• mid ref level —

mid ref level specifies the middle reference level in percent (default) or absolute units. mid
ref level is not used in transition measurements.

• low ref level —

low ref level specifies the low reference level of the waveform in percent (default) or
absolute units.

A rising low ref level crossing defines the beginning of a rising transition and a falling low
ref level crossing defines the end of a falling transition.

• ref units —

ref units specifies whether the high ref level, mid ref level, and low ref level inputs are
interpreted as a percentage (default) of the full range of the waveform or as absolute levels.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• percent level settings —

percent level settings specifies the method LabVIEW uses to determine the high and low state
levels of a waveform.

If you select percent ref units, percent level settings determines the reference levels. Otherwise,
LabVIEW ignores this input.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
the upper and lower regions of the waveform. The upper and lower regions of the
0
waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.

© National Instruments 1085


Functions

Auto select (default)—Determines whether the histogram bins that correspond to the high
and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
2 results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

• histogram size —

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• slope —

slope is an array containing the slew rate for each waveform in signal(s) in. slope is a measure of
the rate of change of the signal in a transition region between high ref level and low ref level.

slope is given by the following equation. where transition


duration is the transition duration for either rising or falling transition polarity and high ref level
and low ref level are in absolute units.

• transition duration —

transition duration is an array of the time spans from when each waveform crosses the low ref
level until it crosses the high ref level in seconds for a rising transition polarity.

The measurement starts at the left edge of the waveform and finds all low ref level crossings
preceding the first high ref level crossing. The final low ref level crossing is used in the
calculation. A rising polarity transition duration is known as rise time, and a falling polarity

1086 ni.com
Functions

transition duration is known as fall time, as shown in the following example:

• pre-transition —

pre-transition contains the undershoot and overshoot for each waveform in signal(s) in.

Refer to the Details section for more information about the pre-transition output.

• undershoot (%) —

undershoot measures the height of the local minimum preceding a rising or falling
transition, which depends on the polarity you specify. Undershoot measures the height as a
percentage of the histogram-based amplitude of the signal.

• overshoot (%) —

overshoot measures the height of the local maximum preceding a rising or falling
transition, which depends on the polarity you specify. Overshoot measures the height as a
percentage of the histogram-based amplitude of the signal.

• post-transition —

post-transition contains the undershoot and overshoot for each waveform in signal(s) in.

Refer to the Details section for more information about the post-transition output.

• undershoot (%) —

undershoot measures the height of the local minimum following a rising or falling, as set by

© National Instruments 1087


Functions

polarity, transition as a percentage of the histogram-based amplitude of the signal.

• overshoot (%) —

overshoot measures the height of the local maximum following a rising or falling, as set by
polarity, transition as a percentage of the histogram-based amplitude of the signal.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info is an array of clusters containing measurement information for each input
waveform.

• start time —

start time specifies the time of the rising (falling) low (high) ref level crossing that defines
the start of the transition to be measured.

• end time —

end time specifies the time of the rising (falling) high (low) ref level crossing that defines the
end of the transition to be measured.

• ref levels —

ref levels returns the three user-defined reference levels of the waveform in absolute units.

LabVIEW uses the reference levels to define the interval of one cycle measurement.

• high ref level —

high ref level returns the high reference level.

• mid ref level —

mid ref level returns the middle reference level.

1088 ni.com
Functions

• low ref level —

low ref level returns the low reference level.

• ref units —

ref units is always absolute in measurement info.

The following information applies to the pre-transition and post-transition outputs of


both instances of this VI.

pre-transition

To calculate the pre-transition undershoot and overshoot, LabVIEW searches for a


local minimum and maximum in the pre-transition aberration region immediately
preceding the beginning of the transition specified by edge number and polarity. The
pre-transition aberration region is defined as the minimum of 3*(end time – start time)
and (current transition start time – previous transition end time) / 2. If the transition to
measure is the first in the waveform, the interval is defined as the minimum of 3*(end
time – start time) and (start time – beginning of the waveform).

If polarity is falling, LabVIEW calculates the pre-transition undershoot using the


following equation:

If polarity is rising, LabVIEW calculates the pre-transition undershoot using the


following equation:

If polarity is falling, LabVIEW calculates the pre-transition overshoot using the


following equation:

© National Instruments 1089


Functions

If polarity is rising, LabVIEW calculates the pre-transition overshoot using the


following equation:

Note LabVIEW uses the Histogram method to calculate the state levels and
amplitude, regardless of the method specified by percent level settings.

post-transition

To calculate the post-transition undershoot and overshoot, LabVIEW searches for a


local minimum and maximum in the post-transition aberration region immediately
following the end of the transition specified by edge number and polarity. The post-
transition aberration region is defined as the minimum of 3*(end time – start time) and
(next transition start time – current transition end time) / 2. If the transition to measure
is the last in the waveform, the interval is defined as the minimum of 3*(end time –
start time) and (end of the waveform – end time).

If polarity is falling, LabVIEW calculates the post-transition undershoot using the


following equation:

If polarity is rising, LabVIEW calculates the post-transition undershoot using the


following equation:

If polarity is falling, LabVIEW calculates the post-transition overshoot using the


following equation:

If polarity is rising, LabVIEW calculates the post-transition overshoot using the

1090 ni.com
Functions

following equation:

Note LabVIEW uses the Histogram method to calculate the state levels and
amplitude, regardless of the method specified by percent level settings.

Example Illustrations

The following illustration shows the undershoot and overshoot in a negative single
transition.

The following illustration shows the undershoot and overshoot in a positive single
transition.

© National Instruments 1091


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Pulse Measurements
Accepts a periodic waveform or an array of periodic waveforms and returns the period,
pulse duration (pulse width), duty cycle (duty factor), and pulse center of a selected
pulse and period. Wire data to the signal in input to determine the polymorphic
instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

• Pulse Measurements 1 chan VI


• Pulse Measurements N chan VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition

1092 ni.com
Functions

Measurements.vi

Pulse Measurements 1 chan VI


Accepts a periodic waveform or an array of periodic waveforms and returns the period,
pulse duration (pulse width), duty cycle (duty factor), and pulse center of a selected
pulse and period. Wire data to the signal in input to determine the polymorphic
instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

Inputs/Outputs
• export mode —

export mode specifies whether this VI returns the period or duty cycle outputs.

0 all (default)–Returns period, pulse duration, duty cycle, and measurement info.
no period and duty cycle–Returns pulse duration and measurement info but does not return
1
period or duty cycle.

• pulse number (1) —

pulse number specifies which pulse of polarity, high or low, LabVIEW measures.

For pulse number n with polarity low, the VI measures the pulse duration and center of the nth
low pulse. The VI measures the period and duty cycle of the period that begins with the (2n –

© National Instruments 1093


Functions

1)th mid ref level crossing.

• signal in —

signal in is the waveform to measure. The waveform must contain at least pulse number
complete cycles, where a cycle is the interval between two consecutive mid ref level crossings in
the same direction.

• polarity (high) —

polarity defines a pulse as high (default) or low. A high pulse consists of the interval between a
rising mid ref level crossing and the next falling mid ref level crossing.

• reference levels —

reference levels specifies the high, middle, and low reference levels of a waveform.

LabVIEW uses the reference levels to define the measurement interval of one complete cycle.
The distance between the mid ref level and the high ref level must equal the distance between
the low ref level and the mid ref level. If the two distances are not equal, LabVIEW adjusts either
the high ref level or the low ref level to match the smaller of the two distances. For example, if
you specify a high ref level of 90%, a mid ref level of 50%, and a low ref level of 20%, LabVIEW
uses 80% instead of 90% for the high ref level.

• high ref level —

high ref level specifies the high reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the rising direction, it must cross the high ref
level before the next falling mid ref level crossing can be counted.

• mid ref level —

mid ref level specifies the middle reference level in percent (default) or absolute units.

The interval between consecutive rising mid ref level crossings defines one cycle, or period,
of the waveform. At least one high/low reference level crossing must separate each mid ref
level crossing.

• low ref level —

1094 ni.com
Functions

low ref level specifies the low reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the falling direction, it must cross the low ref
level before the next rising mid ref level crossing can be counted.

• ref units —

ref units specifies whether the high ref level, mid ref level, and low ref level inputs are
interpreted as a percentage (default) of the full range of the waveform or as absolute levels.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• percent level settings —

percent level settings specifies the method LabVIEW uses to determine the high and low state
levels of a waveform.

If you select percent ref units, percent level settings determines the reference levels. Otherwise,
LabVIEW ignores this input.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
the upper and lower regions of the waveform. The upper and lower regions of the
0
waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.
Auto select (default)—Determines whether the histogram bins that correspond to the high
and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
2 results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

• histogram size —

© National Instruments 1095


Functions

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• period —

period returns the time between adjacent mid ref level crossings in the same direction in
seconds.

The reciprocal of this value is the signal frequency. The measurement interval includes the pulse
you specify in pulse number.

• pulse duration —

pulse duration is the time difference in seconds between the first two mid ref level crossings of
the pulse number. pulse duration is also known as pulse width.

• duty cycle —

duty cycle is a fraction of a period.

duty cycle is also known as duty factor. LabVIEW uses the following equation to calculate duty
cycle: In this equation, pulse duration can refer to the high or
low portion of the period, depending on whether polarity is high pulse or low pulse.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

1096 ni.com
Functions

measurement info returns the pulse-center time of the selected pulse and the absolute
reference levels LabVIEW uses to define the measurement cycle.

• pulse center —

pulse center specifies the time instant of the midpoint of the pulse number.

pulse center for a polarity of high pulse is given by the following equation:

where tc is the pulse center time, tf is the time instant of the falling mid ref level crossing,
and tr is the time instant of the preceding rising mid ref level crossing.

• ref levels —

ref levels returns the three user-defined reference levels of the waveform in absolute units.

LabVIEW uses the reference levels to define the interval of one cycle measurement.

• high ref level —

high ref level returns the high reference level.

• mid ref level —

mid ref level returns the middle reference level.

• low ref level —

low ref level returns the low reference level.

• ref units —

ref units is always absolute in measurement info.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\

© National Instruments 1097


Functions

Pulse and Transition Measurements.vi


• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Pulse Measurements N chan VI


Accepts a periodic waveform or an array of periodic waveforms and returns the period,
pulse duration (pulse width), duty cycle (duty factor), and pulse center of a selected
pulse and period. Wire data to the signal in input to determine the polymorphic
instance to use or manually select the instance.

Note The terminology and measurement definitions for this VI comply with
IEEE Standard 181-2003, IEEE Standard on Transitions, Pulses,
and Related Waveforms.

Inputs/Outputs
• export mode —

export mode specifies whether this VI returns the period or duty cycle outputs.

0 all (default)–Returns period, pulse duration, duty cycle, and measurement info.
no period and duty cycle–Returns pulse duration and measurement info but does not return
1
period or duty cycle.

• pulse number (1) —

pulse number specifies which pulse of polarity, high or low, LabVIEW measures.

1098 ni.com
Functions

For pulse number n with polarity low, the VI measures the pulse duration and center of the nth
low pulse. The VI measures the period and duty cycle of the period that begins with the (2n –
1)th mid ref level crossing.

• signal(s) in —

signal(s) in is the array of waveforms to measure. The waveform must contain at least pulse
number complete cycles, where a cycle is the interval between two consecutive mid ref level
crossings in the same direction.

• polarity (high) —

polarity defines a pulse as high (default) or low. A high pulse consists of the interval between a
rising mid ref level crossing and the next falling mid ref level crossing.

• reference levels —

reference levels specifies the high, middle, and low reference levels of a waveform.

LabVIEW uses the reference levels to define the measurement interval of one complete cycle.
The distance between the mid ref level and the high ref level must equal the distance between
the low ref level and the mid ref level. If the two distances are not equal, LabVIEW adjusts either
the high ref level or the low ref level to match the smaller of the two distances. For example, if
you specify a high ref level of 90%, a mid ref level of 50%, and a low ref level of 20%, LabVIEW
uses 80% instead of 90% for the high ref level.

• high ref level —

high ref level specifies the high reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the rising direction, it must cross the high ref
level before the next falling mid ref level crossing can be counted.

• mid ref level —

mid ref level specifies the middle reference level in percent (default) or absolute units.

The interval between consecutive rising mid ref level crossings defines one cycle, or period,
of the waveform. At least one high/low reference level crossing must separate each mid ref
level crossing.

© National Instruments 1099


Functions

• low ref level —

low ref level specifies the low reference level of the waveform in percent (default) or
absolute units.

After the signal crosses the mid ref level in the falling direction, it must cross the low ref
level before the next rising mid ref level crossing can be counted.

• ref units —

ref units specifies whether the high ref level, mid ref level, and low ref level inputs are
interpreted as a percentage (default) of the full range of the waveform or as absolute levels.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• percent level settings —

percent level settings specifies the method LabVIEW uses to determine the high and low state
levels of a waveform.

If you select percent ref units, percent level settings determines the reference levels. Otherwise,
LabVIEW ignores this input.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
the upper and lower regions of the waveform. The upper and lower regions of the
0
waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.
Auto select (default)—Determines whether the histogram bins that correspond to the high
and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
2 results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

1100 ni.com
Functions

• histogram size —

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• period —

period is an array that contains the period for each waveform in signal(s) in. period returns the
time between adjacent mid ref level crossings in the same direction in seconds.

The reciprocal of this value is the signal frequency. The measurement interval includes the pulse
you specify in pulse number.

• pulse duration —

pulse duration is an array that contains the pulse duration for each waveform in signal(s) in.
pulse duration is the time difference in seconds between the first two mid ref level crossings of
the pulse number. pulse duration is also known as pulse width.

• duty cycle —

duty cycle is an array that contains the duty cycle for each waveform in signal(s) in.

duty cycle is also known as duty factor. LabVIEW uses the following equation to calculate duty
cycle: In this equation, pulse duration can refer to the high or
low portion of the period, depending on whether polarity is high pulse or low pulse.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 1101


Functions

• measurement info —

measurement info is an array of clusters that returns the pulse center time of the selected pulse
and the absolute reference levels LabVIEW uses to define the measurement cycle for each input
waveform.

• pulse center —

pulse center specifies the time instant of the midpoint of the pulse number.

pulse center for a polarity of high pulse is given by the following equation:

where tc is the pulse center time, tf is the time instant of the falling mid ref level crossing,
and tr is the time instant of the preceding rising mid ref level crossing.

• ref levels —

ref levels returns the three user-defined reference levels of the waveform in absolute units.

LabVIEW uses the reference levels to define the interval of one cycle measurement.

• high ref level —

high ref level returns the high reference level.

• mid ref level —

mid ref level returns the middle reference level.

• low ref level —

low ref level returns the low reference level.

• ref units —

ref units is always absolute in measurement info.

Examples

Refer to the following example files included with LabVIEW.

1102 ni.com
Functions

• labview\examples\Signal Processing\Waveform Measurements\


Pulse and Transition Measurements.vi
• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Reference and State Levels


Pulse and transition waveform measurements require a means of identifying the
position in time of the waveform feature to be measured. State and reference levels
provide a means of accomplishing this identification, resulting in a measurement time
interval that you can use as a basis for various time-domain measurements.

State Levels

Pulses or transitions involve changes in the waveform level between various


conditions, or states. The most common case is a two-state waveform with a high state
and a low state. For example, an ideal digital signal might be defined as in the high
state at 5 volts and in the low state at 0 volts.

Reference Levels

Reference levels allow you to extract information from the waveform by identifying
reference level crossings. Two adjacent waveform samples separated in magnitude by
a reference level constitute a reference level crossing. Linear interpolation gives an
approximation to the exact time instant of a reference level crossing, as shown in the
following illustration.

© National Instruments 1103


Functions

You can specify reference levels as a percentage of the state levels, with the low state
and high state corresponding to 0 and 100%, respectively. The most common low, mid,
and high reference levels are 10, 50, and 90%. The following illustration shows a typical
selection of state and reference levels for a pulse waveform.

The histogram method was used to determine the state levels. The histogram method
has the advantage of excluding the undershoot and overshoot peaks.

Amplitude and Levels


Returns the amplitude, high state level, and low state level of a waveform or an array
of waveforms. Wire data to the signal in input to determine the polymorphic instance
to use or manually select the instance.

• Amplitude and Levels 1 chan VI


• Amplitude and Levels N chan VI

The terminology and measurement definitions for this VI comply with IEEE Standard
181-2003, IEEE Standard on Transitions, Pulses, and Related Waveforms.

Examples

Refer to the following example files included with LabVIEW.

1104 ni.com
Functions

• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Amplitude and Levels 1 chan VI


Returns the amplitude, high state level, and low state level of a waveform or an array
of waveforms. Wire data to the signal in input to determine the polymorphic instance
to use or manually select the instance.

Inputs/Outputs
• signal in —

signal in is the waveform to measure.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• state settings —

state settings specifies the method used to determine the high and low state levels of a
waveform.

For pulse and transition waveform measurements, state levels provide a means to identify the
position in time of the waveform feature to be measured.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

© National Instruments 1105


Functions

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
the upper and lower regions of the waveform. The upper and lower regions of the
0
waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.
Auto select (default)—Determines whether the histogram bins that correspond to the high
and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
2 results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

• histogram size —

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• amplitude —

amplitude is the difference between high state level and low state level.

• high state level —

high state level returns the level at which a pulse or transition waveform is defined to be in its
highest state.

• low state level —

low state level returns the level at which a pulse or transition waveform is defined to be in its
lowest state

1106 ni.com
Functions

• error out —

error out contains error information. This output provides standard error out functionality.

The terminology and measurement definitions for this VI comply with IEEE Standard
181-2003, IEEE Standard on Transitions, Pulses, and Related Waveforms.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Amplitude and Levels N chan VI


Returns the amplitude, high state level, and low state level of a waveform or an array
of waveforms. Wire data to the signal in input to determine the polymorphic instance
to use or manually select the instance.

Inputs/Outputs
• signal(s) in —

signal(s) in is an array of waveforms containing the signals to measure.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• state settings —

© National Instruments 1107


Functions

state settings specifies the method used to determine the high and low state levels of a
waveform.

For pulse and transition waveform measurements, state levels provide a means to identify the
position in time of the waveform feature to be measured.

• method —

method specifies how LabVIEW computes the high and low state levels of the waveform.

Histogram—Returns the levels of the histogram bins with the maximum number of hits in
the upper and lower regions of the waveform. The upper and lower regions of the
0
waveform include the upper and lower 40%, respectively, of the peak-to-peak range of the
waveform.
1 Peak—Searches the entire waveform for its maximum and minimum levels.
Auto select (default)—Determines whether the histogram bins that correspond to the high
and low state levels each have over 5% of the total hits. If so, LabVIEW returns those
2 results. Otherwise, LabVIEW uses the peak method. This ensures a reasonable answer for
either a square wave (ignoring the overshoot and undershoot) or a triangle wave (where a
histogram fails).

• histogram size —

histogram size specifies the number of bins in the histogram LabVIEW uses to determine
the high and low state levels of the waveform.

• histogram method —

histogram method specifies how LabVIEW computes the high and low state levels of the
waveform. Currently, mode is the only available histogram method.

0 mode

• reserved —

reserved is reserved for future use.

• amplitude —

amplitude is an array containing the amplitude of each waveform in signal(s) in.

1108 ni.com
Functions

• high state level —

high state level is an array containing the high state level of each waveform in signal(s) in.

• low state level —

low state level is an array containing the low state level of each waveform in signal(s) in.

• error out —

error out contains error information. This output provides standard error out functionality.

The terminology and measurement definitions for this VI comply with IEEE Standard
181-2003, IEEE Standard on Transitions, Pulses, and Related Waveforms.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform
Measurements\N channel Pulse and Transition
Measurements.vi

Extract Single Tone Information


Takes a signal in, finds the single tone with the highest amplitude or searches a
specified frequency range, and returns the single tone frequency, amplitude, and
phase. The input signal can be real or complex and single-channel or multichannel.
Wire data to the time signal in input to determine the polymorphic instance to use or
manually select the instance.

• Extract Single Tone Information 1 Chan VI


• Extract Single Tone Information 1 Chan (CDB) VI
• Extract Single Tone Information N Chan VI

© National Instruments 1109


Functions

• Extract Single Tone Information N Chan (CDB) VI

A real tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

A complex tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Conditioning\


Correct for MIO inter-channel delay (continuous).vi
• labview\examples\Signal Processing\Waveform Measurements\
Single Tone Measurements.vi
• labview\examples\Signal Processing\Waveform Measurements\
Complex Single Tone Measurements.vi

1110 ni.com
Functions

Extract Single Tone Information 1 Chan VI


Takes a signal in, finds the single tone with the highest amplitude or searches a
specified frequency range, and returns the single tone frequency, amplitude, and
phase. The input signal can be real or complex and single-channel or multichannel.
Wire data to the time signal in input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• time signal in —

time signal in is the time-domain waveform.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Single tone
3 residual signal—Signal minus tone

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, center frequency, and width. You
use advanced search for narrowing the single tone search range.

© National Instruments 1111


Functions

• approx freq. (optional) —

approx freq. is the center frequency used of the frequency domain search for the single
tone. The default is –1.0, which means the VI searches the tone in the full frequency range of
(0, Fs/2).

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the single tone frequency.

• exported signals —

exported signals contains the signals specified by export mode.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected frequency —

1112 ni.com
Functions

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to the angle
in input on the Wrap Angle VI, and select degree in, degree out or degree in,
radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns information about your measurement, mainly warnings for
inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

A real tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,

© National Instruments 1113


Functions

respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

A complex tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Conditioning\


Correct for MIO inter-channel delay (continuous).vi
• labview\examples\Signal Processing\Waveform Measurements\
Single Tone Measurements.vi
• labview\examples\Signal Processing\Waveform Measurements\
Complex Single Tone Measurements.vi

Extract Single Tone Information 1 Chan


(CDB) VI
Takes a signal in, finds the single tone with the highest amplitude or searches a
specified frequency range, and returns the single tone frequency, amplitude, and

1114 ni.com
Functions

phase. The input signal can be real or complex and single-channel or multichannel.
Wire data to the time signal in input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• time signal in —

time signal in is the time-domain waveform.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Single tone
3 residual signal—Signal minus tone

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, center frequency, and width. You
use advanced search for narrowing the single tone search range.

• approx freq. (optional) —

approx freq. is the center frequency used of the frequency domain search for the single
tone. The default is NaN, which means the VI searches the tone in the full frequency range of
(–Fs/2, Fs/2).

© National Instruments 1115


Functions

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the single tone frequency.

• exported signals —

exported signals contains the signals specified by export mode.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected frequency —

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

1116 ni.com
Functions

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to the angle
in input on the Wrap Angle VI, and select degree in, degree out or degree in,
radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns information about your measurement, mainly warnings for
inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

A real tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

A complex tone signal can be expressed as shown in the following equation:

© National Instruments 1117


Functions

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Conditioning\


Correct for MIO inter-channel delay (continuous).vi
• labview\examples\Signal Processing\Waveform Measurements\
Single Tone Measurements.vi
• labview\examples\Signal Processing\Waveform Measurements\
Complex Single Tone Measurements.vi

Extract Single Tone Information N Chan VI


Takes a signal in, finds the single tone with the highest amplitude or searches a
specified frequency range, and returns the single tone frequency, amplitude, and
phase. The input signal can be real or complex and single-channel or multichannel.
Wire data to the time signal in input to determine the polymorphic instance to use or
manually select the instance.

Note

1118 ni.com
Functions

The waveform array input should be the result of a multichannel acquisition


where each element of the array of waveforms is a distinct and separate
channel of data.

Inputs/Outputs
• time signals in —

time signals in is an array of time-domain waveforms.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Single tone
3 residual signal—Signal minus tone

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, center frequency, and width. You
use advanced search for narrowing the single tone search range.

• approx freq. (optional) —

© National Instruments 1119


Functions

approx freq. is the center frequency used of the frequency domain search for the single
tone. The default is –1.0, which means the VI searches the tone in the full frequency range of
(0, Fs/2).

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the single tone frequency.

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected frequencies —

detected frequencies is an array of frequencies of the detected single tone in Hz for each

1120 ni.com
Functions

waveform.

• detected amplitudes —

detected amplitudes is an array of peak amplitudes of the detected single tone for each
waveform.

• detected phases (deg) —

detected phases is an array of phases of the detected single tone in degrees for each waveform.

Use the Wrap Angle VI to change the units of detected phases. Wire detected phases to the
angle in input on the Wrap Angle VI, and select degree in, degree out or degree in,
radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurements info —

measurements info is an array that returns information about your measurement, mainly
warnings for inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

A real tone signal can be expressed as shown in the following equation:

© National Instruments 1121


Functions

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

A complex tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Conditioning\


Correct for MIO inter-channel delay (continuous).vi
• labview\examples\Signal Processing\Waveform Measurements\
Single Tone Measurements.vi
• labview\examples\Signal Processing\Waveform Measurements\
Complex Single Tone Measurements.vi

Extract Single Tone Information N Chan


(CDB) VI
Takes a signal in, finds the single tone with the highest amplitude or searches a

1122 ni.com
Functions

specified frequency range, and returns the single tone frequency, amplitude, and
phase. The input signal can be real or complex and single-channel or multichannel.
Wire data to the time signal in input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• time signals in —

time signals in is an array of time-domain waveforms.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Single tone
3 residual signal—Signal minus tone

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, center frequency, and width. You
use advanced search for narrowing the single tone search range.

• approx freq. (optional) —

approx freq. is the center frequency used of the frequency domain search for the single
tone. The default is NaN, which means the VI searches the tone in the full frequency range of

© National Instruments 1123


Functions

(–Fs/2, Fs/2).

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the single tone frequency.

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected frequencies —

detected frequencies is an array of frequencies of the detected single tone in Hz for each
waveform.

• detected amplitudes —

1124 ni.com
Functions

detected amplitudes is an array of peak amplitudes of the detected single tone for each
waveform.

• detected phases (deg) —

detected phases is an array of phases of the detected single tone in degrees for each waveform.

Use the Wrap Angle VI to change the units of detected phases. Wire detected phases to the
angle in input on the Wrap Angle VI, and select degree in, degree out or degree in,
radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurements info —

measurements info is an array that returns information about your measurement, mainly
warnings for inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

A real tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

© National Instruments 1125


Functions

A complex tone signal can be expressed as shown in the following equation:

where A, f, and φ are the amplitude, frequency, and phase of the tone signal,
respectively, and Fs is the sample rate in samples per second of the input waveform
signal.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Conditioning\


Correct for MIO inter-channel delay (continuous).vi
• labview\examples\Signal Processing\Waveform Measurements\
Single Tone Measurements.vi
• labview\examples\Signal Processing\Waveform Measurements\
Complex Single Tone Measurements.vi

Extract Multiple Tone Information


Returns the frequency, amplitude, and phase for each signal tone whose amplitude
exceeds a specified threshold. Wire data to the time signal in input to determine the
polymorphic instance to use or manually select the instance.

1126 ni.com
Functions

• Extract Multiple Tone Information 1 Chan VI


• Extract Multiple Tone Information 1 Chan (CDB) VI
• Extract Multiple Tone Information N Chan VI
• Extract Multiple Tone Information N Chan - N Specs VI
• Extract Multiple Tone Information N Chan (CDB) VI
• Extract Multiple Tone Information N Chan - N Specs (CDB) VI

The input signal can be real or complex and single-channel, in the form of a waveform,
or multichannel, in the form of an array of waveforms. If you wire an array of real
waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N
Chan instance by default. If you wire an array of complex waveforms to time signal in,
LabVIEW selects the Extract Multiple Tone Information N Chan (CDB) instance by
default.

A real multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

A complex multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

© National Instruments 1127


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Complex Multi-Tone Measurements.vi

Extract Multiple Tone Information 1 Chan VI


Returns the frequency, amplitude, and phase for each signal tone whose amplitude
exceeds a specified threshold. Wire data to the time signal in input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• time signal in —

time signal in is the time-domain waveform.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Multiple tone
3 residual signal—Signal minus tone

• threshold —

threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it
from time signal in.

1128 ni.com
Functions

• max num tones —

max num tones specifies the maximum number of tones that this VI extracts. If you set max num
tones to –1, this VI extracts all tones whose amplitude exceeds threshold.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• output sorting —

output sorting specifies the sorting order of the tones that this VI extracts.

0 increasing frequency
1 decreasing amplitude

• exported signals —

exported signals contains the signals specified by export mode.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

© National Instruments 1129


Functions

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each tone that this VI
extracts. Each element of the array is one single tone.

• detected frequency —

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to the
angle in input on the Wrap Angle VI, and select degree in, degree out or degree
in, radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

The input signal can be real or complex and single-channel, in the form of a waveform,
or multichannel, in the form of an array of waveforms. If you wire an array of real
waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N
Chan instance by default. If you wire an array of complex waveforms to time signal in,
LabVIEW selects the Extract Multiple Tone Information N Chan (CDB) instance by
default.

A real multiple tone signal can be expressed as shown in the following equation:

1130 ni.com
Functions

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

A complex multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Complex Multi-Tone Measurements.vi

Extract Multiple Tone Information 1 Chan


(CDB) VI
Returns the frequency, amplitude, and phase for each signal tone whose amplitude
exceeds a specified threshold. Wire data to the time signal in input to determine the
polymorphic instance to use or manually select the instance.

© National Instruments 1131


Functions

Inputs/Outputs
• time signal in —

time signal in is the time-domain waveform.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Multiple tone
3 residual signal—Signal minus tone

• threshold —

threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it
from time signal in.

• max num tones —

max num tones specifies the maximum number of tones that this VI extracts. If you set max num
tones to –1, this VI extracts all tones whose amplitude exceeds threshold.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• output sorting —

output sorting specifies the sorting order of the tones that this VI extracts.

0 increasing frequency
1 decreasing amplitude

1132 ni.com
Functions

• exported signals —

exported signals contains the signals specified by export mode.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each tone that this VI
extracts. Each element of the array is one single tone.

• detected frequency —

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

© National Instruments 1133


Functions

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to the
angle in input on the Wrap Angle VI, and select degree in, degree out or degree
in, radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

The input signal can be real or complex and single-channel, in the form of a waveform,
or multichannel, in the form of an array of waveforms. If you wire an array of real
waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N
Chan instance by default. If you wire an array of complex waveforms to time signal in,
LabVIEW selects the Extract Multiple Tone Information N Chan (CDB) instance by
default.

A real multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

A complex multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

1134 ni.com
Functions

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For
a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Complex Multi-Tone Measurements.vi

Extract Multiple Tone Information N Chan VI


Returns the frequency, amplitude, and phase for each signal tone whose amplitude
exceeds a specified threshold. Wire data to the time signal in input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• time signals in —

time signals in is an array of time-domain waveforms.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Multiple tone

© National Instruments 1135


Functions

3 residual signal—Signal minus tone

• threshold —

threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it
from time signals in.

• max num tones —

max num tones specifies the maximum number of tones that this VI extracts. If you set max num
tones to –1, this VI extracts all tones whose amplitude exceeds threshold.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• output sorting —

output sorting specifies the sorting order of the tones that this VI extracts.

0 increasing frequency
1 decreasing amplitude

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

1136 ni.com
Functions

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each tone that this VI
extracts. Each element of the array is the multiple tone information for one signal in time signals
in.

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each sine tone
that this VI extracts. Each element of the array is the multiple tone information for one
signal in time signals in.

• detected frequency —

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to

© National Instruments 1137


Functions

the angle in input on the Wrap Angle VI, and select degree in, degree out or
degree in, radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

The input signal can be real or complex and single-channel, in the form of a waveform,
or multichannel, in the form of an array of waveforms. If you wire an array of real
waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N
Chan instance by default. If you wire an array of complex waveforms to time signal in,
LabVIEW selects the Extract Multiple Tone Information N Chan (CDB) instance by
default.

A real multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

A complex multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For

1138 ni.com
Functions

a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Complex Multi-Tone Measurements.vi

Extract Multiple Tone Information N Chan - N


Specs VI
Returns the frequency, amplitude, and phase for each signal tone whose amplitude
exceeds a specified threshold. Wire data to the time signal in input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• time signals in —

time signals in is an array of time-domain waveforms.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only

© National Instruments 1139


Functions

2 detected signal—Multiple tone


3 residual signal—Signal minus tone

• threshold —

threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it
from time signals in. Each element of the array is the threshold for one signal in time signals in.

• max num tones —

max num tones specifies the maximum number of tones that this VI extracts from each signal. If
you set max num tones to –1, this VI extracts all tones whose amplitude exceeds threshold.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• output sorting —

output sorting specifies the sorting order of the tones that this VI extracts.

0 increasing frequency
1 decreasing amplitude

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

1140 ni.com
Functions

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each tone that this VI
extracts. Each element of the array is the multiple tone information for one signal in time signals
in.

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each sine tone
that this VI extracts. Each element of the array is the multiple tone information for one
signal in time signals in.

• detected frequency —

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to

© National Instruments 1141


Functions

the angle in input on the Wrap Angle VI, and select degree in, degree out or
degree in, radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

The input signal can be real or complex and single-channel, in the form of a waveform,
or multichannel, in the form of an array of waveforms. If you wire an array of real
waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N
Chan instance by default. If you wire an array of complex waveforms to time signal in,
LabVIEW selects the Extract Multiple Tone Information N Chan (CDB) instance by
default.

A real multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

A complex multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For

1142 ni.com
Functions

a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Complex Multi-Tone Measurements.vi

Extract Multiple Tone Information N Chan


(CDB) VI
Returns the frequency, amplitude, and phase for each signal tone whose amplitude
exceeds a specified threshold. Wire data to the time signal in input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• time signals in —

time signals in is an array of time-domain waveforms.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only

© National Instruments 1143


Functions

2 detected signal—Multiple tone


3 residual signal—Signal minus tone

• threshold —

threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it
from time signals in.

• max num tones —

max num tones specifies the maximum number of tones that this VI extracts. If you set max num
tones to –1, this VI extracts all tones whose amplitude exceeds threshold.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• output sorting —

output sorting specifies the sorting order of the tones that this VI extracts.

0 increasing frequency
1 decreasing amplitude

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

1144 ni.com
Functions

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each tone that this VI
extracts. Each element of the array is the multiple tone information for one signal in time signals
in.

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each sine tone
that this VI extracts. Each element of the array is the multiple tone information for one
signal in time signals in.

• detected frequency —

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to

© National Instruments 1145


Functions

the angle in input on the Wrap Angle VI, and select degree in, degree out or
degree in, radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

The input signal can be real or complex and single-channel, in the form of a waveform,
or multichannel, in the form of an array of waveforms. If you wire an array of real
waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N
Chan instance by default. If you wire an array of complex waveforms to time signal in,
LabVIEW selects the Extract Multiple Tone Information N Chan (CDB) instance by
default.

A real multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

A complex multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For

1146 ni.com
Functions

a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Complex Multi-Tone Measurements.vi

Extract Multiple Tone Information N Chan - N


Specs (CDB) VI
Returns the frequency, amplitude, and phase for each signal tone whose amplitude
exceeds a specified threshold. Wire data to the time signal in input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• time signals in —

time signals in is an array of time-domain waveforms.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only

© National Instruments 1147


Functions

2 detected signal—Multiple tone


3 residual signal—Signal minus tone

• threshold —

threshold specifies the minimum amplitude that each tone must exceed for this VI to extract it
from time signals in. Each element of the array is the threshold for one signal in time signals in.

• max num tones —

max num tones specifies the maximum number of tones that this VI extracts from each signal. If
you set max num tones to –1, this VI extracts all tones whose amplitude exceeds threshold.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• output sorting —

output sorting specifies the sorting order of the tones that this VI extracts.

0 increasing frequency
1 decreasing amplitude

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

1148 ni.com
Functions

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each tone that this VI
extracts. Each element of the array is the multiple tone information for one signal in time signals
in.

• multiple tone information —

multiple tone information returns the frequency, amplitude, and phase of each sine tone
that this VI extracts. Each element of the array is the multiple tone information for one
signal in time signals in.

• detected frequency —

detected frequency is the frequency of the detected single tone in Hz.

• detected amplitude —

detected amplitude is the peak amplitude of the detected single tone.

• detected phase (deg) —

detected phase is the phase of the detected single tone in degrees.

Use the Wrap Angle VI to change the units of detected phase. Wire detected phase to

© National Instruments 1149


Functions

the angle in input on the Wrap Angle VI, and select degree in, degree out or
degree in, radians out for the angle units input.

• error out —

error out contains error information. This output provides standard error out functionality.

The input signal can be real or complex and single-channel, in the form of a waveform,
or multichannel, in the form of an array of waveforms. If you wire an array of real
waveforms to time signal in, LabVIEW selects the Extract Multiple Tone Information N
Chan instance by default. If you wire an array of complex waveforms to time signal in,
LabVIEW selects the Extract Multiple Tone Information N Chan (CDB) instance by
default.

A real multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

A complex multiple tone signal can be expressed as shown in the following equation:

where Ai, fi, and φi are the amplitude, frequency, and phase, respectively, of the ith
tone of a multiple tone signal with N tones and Fs is the sample rate in samples per
second of the input waveform signal.

For a real signal, the frequency range is (min frequency, max frequency) = (0, Fs/2). For

1150 ni.com
Functions

a complex signal, the frequency range is (min frequency, max frequency) = (–Fs/2,
Fs/2).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Complex Multi-Tone Measurements.vi

Harmonic Distortion Analyzer


Takes a signal in and performs a full harmonic analysis, including measuring the
fundamental frequency tone and harmonics, and returning the fundamental
frequency, all harmonic amplitude levels, and the total harmonic distortion (THD).
Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

• Harmonic Distortion Analyzer 1 Chan VI


• Harmonic Distortion Analyzer N Chan VI

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Multitone with Amplitudes and Phases.vi

© National Instruments 1151


Functions

Harmonic Distortion Analyzer 1 Chan VI


Takes a signal in and performs a full harmonic analysis, including measuring the
fundamental frequency tone and harmonics, and returning the fundamental
frequency, all harmonic amplitude levels, and the total harmonic distortion (THD).
Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

Inputs/Outputs
• stop search at Nyquist —

stop search at Nyquist should be set to TRUE (default) to include only frequencies less than the
Nyquist frequency, or half the sampling rate, in the harmonic search.

When set to FALSE, this VI continues searching the frequency domain beyond Nyquist by
assuming that these higher frequency components have aliased according to the following
equation. aliased f = Fs – (f modulo Fs) where Fs = 1/dt = sampling rate.

• signal in —

signal in is the input time-domain signal.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 fundamental signal—Single sine tone
3 residual signal—Signal minus tone
4 harmonics only—Detected harmonics
5 noise and spurs—Signal minus tone and harmonics

1152 ni.com
Functions

• highest harmonic —

highest harmonic controls the highest harmonic, including the fundamental tone, used for the
harmonic analysis. For example, for 3rd harmonic analysis, this control should be set to 3 to
measure the fundamental, second, and third harmonic.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, which is the center frequency and
width, used for finding the fundamental frequency tone of the signal.

• approx freq. (optional) —

approx freq. is the center frequency used in the frequency domain search for the
fundamental tone frequency. If set to the default value of –1.0, the tone with the highest
amplitude is used as the fundamental tone.

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the fundamental tone frequency.

• exported signals —

exported signals contains the signals specified by export mode.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

© National Instruments 1153


Functions

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected fundamental frequency —

detected fundamental frequency contains the detected fundamental frequency resulting from
searching the frequency domain. Use advanced search to set the frequency search range. All
harmonics are measured at integer multiples of this fundamental frequency.

• THD —

THD contains the measured total harmonic distortion up to and including the highest harmonic.
THD is defined as the ratio of the RMS sum of the harmonics to the amplitude of the
fundamental tone. To compute THD as a percentage, you must multiply it by 100.

• components level —

components level contains the array of amplitudes of the measured harmonics in volts if the
signal in is in volts. The array index is the harmonic number including 0 (DC), 1 (fundamental), 2
(second harmonic),... n (nth harmonic), up to and including the highest harmonic.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns information about your measurement, mainly warnings for
inconsistencies in your input signal.

1154 ni.com
Functions

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Multitone with Amplitudes and Phases.vi

Harmonic Distortion Analyzer N Chan VI


Takes a signal in and performs a full harmonic analysis, including measuring the
fundamental frequency tone and harmonics, and returning the fundamental
frequency, all harmonic amplitude levels, and the total harmonic distortion (THD).
Wire data to the signal in input to determine the polymorphic instance to use or
manually select the instance.

Note

The multichannel waveform array input should be the result of a


multichannel acquisition where each element of the array of waveforms is a

© National Instruments 1155


Functions

distinct and separate channel of data.

Inputs/Outputs
• stop search at Nyquist —

stop search at Nyquist should be set to TRUE (default) to include only frequencies less than the
Nyquist frequency, or half the sampling rate, in the harmonic search.

When set to FALSE, this VI continues searching the frequency domain beyond Nyquist by
assuming that these higher frequency components have aliased according to the following
equation. aliased f = Fs – (f modulo Fs) where Fs = 1/dt = sampling rate.

• signals in —

signals in is the array of input time-domain signals.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 fundamental signal—Single sine tone
3 residual signal—Signal minus tone
4 harmonics only—Detected harmonics
5 noise and spurs—Signal minus tone and harmonics

• highest harmonic —

highest harmonic controls the highest harmonic, including the fundamental tone, used for the
harmonic analysis. For example, for 3rd harmonic analysis, this control should be set to 3 to

1156 ni.com
Functions

measure the fundamental, second, and third harmonic.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, which is the center frequency and
width, used for finding the fundamental frequency tone of the signal.

• approx freq. (optional) —

approx freq. is the center frequency used in the frequency domain search for the
fundamental tone frequency. If set to the default value of –1.0, the tone with the highest
amplitude is used as the fundamental tone.

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the fundamental tone frequency.

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

© National Instruments 1157


Functions

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected fundamental frequencies —

detected fundamental frequencies is an array containing the detected fundamental frequency


resulting from searching the frequency domain for each waveform.

• THD —

THD returns an array containing the measured total harmonic distortion for each waveform.

• components levels —

components levels is a cluster containing an array of amplitudes of the measured harmonics for
each waveform.

• components level —

components level contains the array of amplitudes of the measured harmonics in volts if
the signal in is in volts. The array index is the harmonic number including 0 (DC), 1
(fundamental), 2 (second harmonic),... n (nth harmonic), up to and including the highest
harmonic.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurements info —

1158 ni.com
Functions

measurements info is an array that returns information about your measurement, mainly
warnings for inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Multitone with Amplitudes and Phases.vi

SINAD Analyzer
Takes a signal in and performs a full Signal in Noise and Distortion (SINAD) analysis,
including measuring the fundamental frequency tone and returning the fundamental
frequency and SINAD level in dB. Wire data to the signal in input to determine the
polymorphic instance to use or manually select the instance.

• SINAD Analyzer 1 Chan VI

© National Instruments 1159


Functions

• SINAD Analyzer N Chan VI

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

THD Plus Noise in dB is the negative of the SINAD in dB.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


SINAD Measurement.vi

SINAD Analyzer 1 Chan VI


Takes a signal in and performs a full Signal in Noise and Distortion (SINAD) analysis,
including measuring the fundamental frequency tone and returning the fundamental
frequency and SINAD level in dB. Wire data to the signal in input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• signal in —

signal in is the input time-domain signal.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

1160 ni.com
Functions

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Single tone
3 residual signal—Signal minus tone

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, which is the center frequency and
width, used for finding the fundamental frequency tone of the signal.

• approx freq. (optional) —

approx freq. is the center frequency used in the frequency domain search for the
fundamental tone frequency. If set to the default value of –1.0, the tone with the highest
amplitude is used as the fundamental tone.

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the fundamental tone frequency.

• exported signals —

exported signals contains the signals specified by export mode.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

© National Instruments 1161


Functions

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected fundamental frequency —

detected fundamental frequency contains the detected fundamental frequency resulting from
searching the frequency domain. Use advanced search to set the frequency search range.

• SINAD (dB) —

SINAD contains the measured Signal in Noise and Distortion (SINAD) expressed in dB. SINAD is
defined as the ratio of the RMS energy of signal in to the RMS energy of signal in less the energy
in the fundamental. To compute the THD Plus Noise in dB, simply negate the SINAD in dB.

• THD Plus Noise —

THD Plus Noise contains the measured total harmonic distortion plus noise. THD Plus Noise is
defined as the ratio of the RMS energy of signal in less the energy in the fundamental to the RMS
energy of signal in. To compute THD Plus Noise as a percentage, you must multiply it by 100.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurement info —

measurement info returns information about your measurement, mainly warnings for
inconsistencies in your input signal.

• uncertainty —

1162 ni.com
Functions

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

THD Plus Noise in dB is the negative of the SINAD in dB.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


SINAD Measurement.vi

SINAD Analyzer N Chan VI


Takes a signal in and performs a full Signal in Noise and Distortion (SINAD) analysis,
including measuring the fundamental frequency tone and returning the fundamental
frequency and SINAD level in dB. Wire data to the signal in input to determine the
polymorphic instance to use or manually select the instance.

Note

The multichannel waveform array input should be the result of a


multichannel acquisition where each element of the array of waveforms is a

© National Instruments 1163


Functions

distinct and separate channel of data.

Inputs/Outputs
• signals in —

signals in is the array of input time-domain signals.

• export mode —

export mode selects the source of the signal and spectrum to export to exported signals.

0 none—Fastest computation
1 input signal—Input signal only
2 detected signal—Single tone
3 residual signal—Signal minus tone

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• advanced search —

advanced search controls the frequency domain search area, which is the center frequency and
width, used for finding the fundamental frequency tone of the signal.

• approx freq. (optional) —

approx freq. is the center frequency used in the frequency domain search for the
fundamental tone frequency. If set to the default value of –1.0, the tone with the highest

1164 ni.com
Functions

amplitude is used as the fundamental tone.

• search (+/- % of Fsampl.) —

search is the frequency width, as a percentage of the sampling rate, for the frequency
domain search for the fundamental tone frequency.

• exported signals —

exported signals is an array of exported signals.

• exported time signal —

exported time signal is the waveform containing the exported time signal as selected by
export mode.

• exported spectrum (dB) —

exported spectrum (dB) is the spectrum of the exported time signal as selected by export
mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• dB Spectrum (Hann) —

dB Spectrum (Hann) is the magnitude spectrum of the (Hanning) windowed input


signal, expressed in dB relative to 1.0 Vrms^2 for input signals in units of volts (V).

• detected fundamental frequencies —

detected fundamental frequencies is an array containing the detected fundamental frequency


resulting from searching the frequency domain for each waveform.

• SINAD (dB) —

© National Instruments 1165


Functions

SINAD is an array containing the measured Signal in Noise and Distortion (SINAD) for each
waveform expressed in dB. SINAD is defined as the ratio of the RMS energy of the input signal to
the RMS energy of the input signal less the energy in the fundamental. To compute the THD Plus
Noise in dB, simply negate the SINAD in dB.

• THD Plus Noise —

THD Plus Noise is an array containing the measured total harmonic distortion plus noise for
each waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

• measurements info —

measurements info is an array that returns information about your measurement, mainly
warnings for inconsistencies in your input signal.

• uncertainty —

uncertainty is reserved for future use.

• Warning —

Warning is TRUE if a warning is generated during processing.

• comments —

comments contains a warning message when Warning is TRUE.

This VI is designed to process a single channel or multiple channels continuously,


typically from within a For Loop or a While Loop.

THD Plus Noise in dB is the negative of the SINAD in dB.

Examples

Refer to the following example files included with LabVIEW.

1166 ni.com
Functions

• labview\examples\Signal Processing\Waveform Measurements\


SINAD Measurement.vi

FFT Power Spectrum and PSD


Computes the averaged auto power spectrum of time signal. Wire data to the time
signal input to determine the polymorphic instance to use or manually select the
instance.

• FFT Power Spectrum and PSD for 1 Chan VI


• FFT Power Spectrum and PSD for N Chan VI
• FFT Power Spectrum and PSD for 1 Chan (CDB) VI
• FFT Power Spectrum and PSD for N Chan (CDB) VI

The FFT Power Spectrum VI completes the following steps to compute power
spectrum or power spectral density:

1. Computes the FFT of time signal.


2. Forms the power spectrum or power spectral density of time signal.
3. Averages the current power spectrum/power spectral density with the power
spectra/power spectral densities computed in previous calls to the VI since the last
time the averaging process was restarted.
4. Returns the averaged power spectrum or power spectral densities in Power
Spectrum/PSD.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected

© National Instruments 1167


Functions

behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

FFT Power Spectrum and PSD for 1 Chan VI


Computes the averaged auto power spectrum of time signal. Wire data to the time
signal input to determine the polymorphic instance to use or manually select the
instance.

Inputs/Outputs
• export mode —

export mode selects the output to export to Power Spectrum / PSD.

0 Power Spectrum–exports the power spectrum of the input signal.


1 Power Spectral Density–exports the power spectral density of the input signal.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical

1168 ni.com
Functions

case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal —

time signal is the input time-domain waveform.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

© National Instruments 1169


Functions

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• Power Spectrum / PSD —

Power Spectrum / PSD returns the averaged power spectrum or power spectral density and the

1170 ni.com
Functions

frequency scale, according to export mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged power spectrum or power spectral density.

If the input signal is in volts (V), magnitude has units of volts-rms squared (Vrms²) for power
spectrum and volts-rms squared per hertz (Vrms²/Hz) for power spectral density. If the input
signal is not in volts, magnitude has units of the input signal unit-rms squared for power
spectrum, and input signal unit-rms squared per hertz for power spectral density. If dB On is
TRUE and the input signal is in volts, magnitude has units of dBV for power spectrum and
dBV/Hz for power spectral density.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Power Spectrum VI completes the following steps to compute power
spectrum or power spectral density:

1. Computes the FFT of time signal.


2. Forms the power spectrum or power spectral density of time signal.

© National Instruments 1171


Functions

3. Averages the current power spectrum/power spectral density with the power
spectra/power spectral densities computed in previous calls to the VI since the last
time the averaging process was restarted.
4. Returns the averaged power spectrum or power spectral densities in Power
Spectrum/PSD.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

FFT Power Spectrum and PSD for N Chan VI


Computes the averaged auto power spectrum of time signal. Wire data to the time
signal input to determine the polymorphic instance to use or manually select the
instance.

1172 ni.com
Functions

Inputs/Outputs
• export mode —

export mode selects the output to export to Power Spectrum / PSD.

0 Power Spectrum–exports the power spectrum of the input signal.


1 Power Spectral Density–exports the power spectral density of the input signal.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals —

time signals is the input array of time-domain waveforms.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning

© National Instruments 1173


Functions

32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

1174 ni.com
Functions

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• Power Spectrum / PSD —

Power Spectrum / PSD returns the averaged power spectrum or power spectral density and the
frequency scale, according to export mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged power spectrum or power spectral density.

If the input signal is in volts (V), magnitude has units of volts-rms squared (Vrms²) for power
spectrum and volts-rms squared per hertz (Vrms²/Hz) for power spectral density. If the input
signal is not in volts, magnitude has units of the input signal unit-rms squared for power
spectrum, and input signal unit-rms squared per hertz for power spectral density. If dB On is
TRUE and the input signal is in volts, magnitude has units of dBV for power spectrum and
dBV/Hz for power spectral density.

• averaging done —

© National Instruments 1175


Functions

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Power Spectrum VI completes the following steps to compute power
spectrum or power spectral density:

1. Computes the FFT of time signal.


2. Forms the power spectrum or power spectral density of time signal.
3. Averages the current power spectrum/power spectral density with the power
spectra/power spectral densities computed in previous calls to the VI since the last
time the averaging process was restarted.
4. Returns the averaged power spectrum or power spectral densities in Power
Spectrum/PSD.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to

1176 ni.com
Functions

the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

FFT Power Spectrum and PSD for 1 Chan


(CDB) VI
Computes the averaged auto power spectrum of time signal. Wire data to the time
signal input to determine the polymorphic instance to use or manually select the
instance.

Inputs/Outputs
• export mode —

export mode selects the output to export to Power Spectrum / PSD.

0 Power Spectrum–exports the power spectrum of the input signal.


1 Power Spectral Density–exports the power spectral density of the input signal.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal —

© National Instruments 1177


Functions

time signal is the input time-domain waveform.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

1178 ni.com
Functions

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• Power Spectrum / PSD —

Power Spectrum / PSD returns the averaged power spectrum or power spectral density and the
frequency scale, according to export mode.

• f0 —

© National Instruments 1179


Functions

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged power spectrum or power spectral density.

If the input signal is in volts (V), magnitude has units of volts-rms squared (Vrms²) for power
spectrum and volts-rms squared per hertz (Vrms²/Hz) for power spectral density. If the input
signal is not in volts, magnitude has units of the input signal unit-rms squared for power
spectrum, and input signal unit-rms squared per hertz for power spectral density. If dB On is
TRUE and the input signal is in volts, magnitude has units of dBV for power spectrum and
dBV/Hz for power spectral density.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Power Spectrum VI completes the following steps to compute power
spectrum or power spectral density:

1. Computes the FFT of time signal.


2. Forms the power spectrum or power spectral density of time signal.
3. Averages the current power spectrum/power spectral density with the power
spectra/power spectral densities computed in previous calls to the VI since the last
time the averaging process was restarted.

1180 ni.com
Functions

4. Returns the averaged power spectrum or power spectral densities in Power


Spectrum/PSD.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

FFT Power Spectrum and PSD for N Chan


(CDB) VI
Computes the averaged auto power spectrum of time signal. Wire data to the time
signal input to determine the polymorphic instance to use or manually select the
instance.

© National Instruments 1181


Functions

Inputs/Outputs
• export mode —

export mode selects the output to export to Power Spectrum / PSD.

0 Power Spectrum–exports the power spectrum of the input signal.


1 Power Spectral Density–exports the power spectral density of the input signal.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals —

time signals is the input array of time-domain waveforms.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning

1182 ni.com
Functions

32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

© National Instruments 1183


Functions

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• Power Spectrum / PSD —

Power Spectrum / PSD returns the averaged power spectrum or power spectral density and the
frequency scale, according to export mode.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged power spectrum or power spectral density.

If the input signal is in volts (V), magnitude has units of volts-rms squared (Vrms²) for power
spectrum and volts-rms squared per hertz (Vrms²/Hz) for power spectral density. If the input
signal is not in volts, magnitude has units of the input signal unit-rms squared for power
spectrum, and input signal unit-rms squared per hertz for power spectral density. If dB On is
TRUE and the input signal is in volts, magnitude has units of dBV for power spectrum and
dBV/Hz for power spectral density.

• averaging done —

1184 ni.com
Functions

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Power Spectrum VI completes the following steps to compute power
spectrum or power spectral density:

1. Computes the FFT of time signal.


2. Forms the power spectrum or power spectral density of time signal.
3. Averages the current power spectrum/power spectral density with the power
spectra/power spectral densities computed in previous calls to the VI since the last
time the averaging process was restarted.
4. Returns the averaged power spectrum or power spectral densities in Power
Spectrum/PSD.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to

© National Instruments 1185


Functions

the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

FFT Spectrum (Mag-Phase)


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
magnitude and phase. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

• FFT Spectrum (Mag-Phase) for 1 Chan VI


• FFT Spectrum (Mag-Phase) for N Chan VI
• FFT Spectrum (Mag-Phase) for 1 Chan (CDB) VI
• FFT Spectrum (Mag-Phase) for N Chan (CDB) VI

The FFT Spectrum (Mag-Phase) VI completes the following steps to compute


magnitude and phase:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the magnitude and phase of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

1186 ni.com
Functions

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Mag-Phase) VI in a loop:

labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based Vis

FFT Spectrum (Mag-Phase) for 1 Chan VI


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
magnitude and phase. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

© National Instruments 1187


Functions

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal —

time signal is the input time-domain waveform.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

1188 ni.com
Functions

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear

© National Instruments 1189


Functions

Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitude —

magnitude returns the magnitude of the averaged FFT spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged FFT spectrum.

1190 ni.com
Functions

If the input signal is in volts (V), magnitude has units of volts-rms (Vrms). If the input signal is
not in volts, magnitude has units of the input signal unit-rms. If dB On is TRUE and the
input signal is in volts, magnitude has units of dBV.

• phase —

phase returns the phase of the averaged FFT spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase is the phase, in radians, of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Spectrum (Mag-Phase) VI completes the following steps to compute


magnitude and phase:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the magnitude and phase of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple

© National Instruments 1191


Functions

calls with history. The single-channel version can perform multichannel


measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Mag-Phase) VI in a loop:

labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based Vis

FFT Spectrum (Mag-Phase) for N Chan VI


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
magnitude and phase. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Note

This VI applies the same averaging parameters settings to each waveform in

1192 ni.com
Functions

time signals.

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals —

time signals is the input array of time-domain waveforms.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris

© National Instruments 1193


Functions

8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The

1194 ni.com
Functions

specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging modes.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.

© National Instruments 1195


Functions

averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitudes —

magnitudes is an array of magnitudes of the averaged FFT spectra, one per input waveform.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged FFT spectrum.

If the input signal is in volts (V), magnitude has units of volts-rms (Vrms). If the input signal is
not in volts, magnitude has units of the input signal unit-rms. If dB On is TRUE and the
input signal is in volts, magnitude has units of dBV.

• phases —

phases is an array of phases of the averaged FFT spectra, one per input waveform.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase is the phase, in radians, of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

1196 ni.com
Functions

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Spectrum (Mag-Phase) VI completes the following steps to compute


magnitude and phase:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the magnitude and phase of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Mag-Phase) VI in a loop:

labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

© National Instruments 1197


Functions

Related Information

Output Units for FFT-Based Vis

FFT Spectrum (Mag-Phase) for 1 Chan (CDB)


VI
Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
magnitude and phase. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal —

time signal is the input time-domain waveform.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

1198 ni.com
Functions

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

© National Instruments 1199


Functions

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

1200 ni.com
Functions

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitude —

magnitude returns the magnitude of the averaged FFT spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged FFT spectrum.

If the input signal is in volts (V), magnitude has units of volts-rms (Vrms). If the input signal is
not in volts, magnitude has units of the input signal unit-rms. If dB On is TRUE and the
input signal is in volts, magnitude has units of dBV.

• phase —

phase returns the phase of the averaged FFT spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

© National Instruments 1201


Functions

phase is the phase, in radians, of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Spectrum (Mag-Phase) VI completes the following steps to compute


magnitude and phase:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the magnitude and phase of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

1202 ni.com
Functions

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Mag-Phase) VI in a loop:

labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based Vis

FFT Spectrum (Mag-Phase) for N Chan (CDB)


VI
Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
magnitude and phase. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

© National Instruments 1203


Functions

• time signals —

time signals is the input array of time-domain waveforms.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning

1204 ni.com
Functions

the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

© National Instruments 1205


Functions

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitudes —

magnitudes is an array of magnitudes of the averaged FFT spectra, one per input waveform.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged FFT spectrum.

If the input signal is in volts (V), magnitude has units of volts-rms (Vrms). If the input signal is
not in volts, magnitude has units of the input signal unit-rms. If dB On is TRUE and the
input signal is in volts, magnitude has units of dBV.

• phases —

1206 ni.com
Functions

phases is an array of phases of the averaged FFT spectra, one per input waveform.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase is the phase of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Spectrum (Mag-Phase) VI completes the following steps to compute


magnitude and phase:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the magnitude and phase of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected

© National Instruments 1207


Functions

behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Mag-Phase) VI in a loop:

labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based Vis

FFT Spectrum (Real-Im)


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
real and imaginary parts. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

• FFT Spectrum (Real-Im) for 1 Chan VI


• FFT Spectrum (Real-Im) for N Chan VI
• FFT Spectrum (Real-Im) for 1 Chan (CDB) VI
• FFT Spectrum (Real-Im) for N Chan (CDB) VI

The FFT Spectrum (Real-IM) VI completes the following steps to compute real part and
imaginary part:

1208 ni.com
Functions

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the real and imaginary parts of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Real-IM) VI in a loop:

• labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based VIs

FFT Spectrum (Real-Im) for 1 Chan VI


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as

© National Instruments 1209


Functions

real and imaginary parts. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal —

time signal is the input time-domain waveform.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall

1210 ni.com
Functions

30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

© National Instruments 1211


Functions

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real part —

real part returns the real part of the averaged FFT spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

real part is the real part of the averaged FFT spectrum.

If the input signal is in volts (V), real part has units of volts-rms (Vrms). If the input signal is
not in volts, real part has units of the input signal unit-rms.

• imaginary part —

1212 ni.com
Functions

imaginary part returns the imaginary part of the averaged FFT spectrum and the frequency
scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imaginary part —

imaginary part is the imaginary part of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Spectrum (Real-IM) VI completes the following steps to compute real part and
imaginary part:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the real and imaginary parts of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without

© National Instruments 1213


Functions

using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Real-IM) VI in a loop:

• labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based VIs

FFT Spectrum (Real-Im) for N Chan VI


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
real and imaginary parts. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Note

This VI applies the same averaging parameters settings to each waveform in


time signals.

1214 ni.com
Functions

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals —

time signals is the input array of time-domain waveforms.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen

© National Instruments 1215


Functions

34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

1216 ni.com
Functions

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real parts —

real parts returns an array of the real part of the averaged FFT spectra, one per input waveform.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

real part is the real part of the averaged FFT spectrum.

If the input signal is in volts (V), real part has units of volts-rms (Vrms). If the input signal is
not in volts, real part has units of the input signal unit-rms.

• imaginary parts —

imaginary parts returns the imaginary part of the averaged FFT spectra and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

© National Instruments 1217


Functions

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imaginary part —

imaginary part is the imaginary part of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Spectrum (Real-IM) VI completes the following steps to compute real part and
imaginary part:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the real and imaginary parts of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for

1218 ni.com
Functions

continuous processing of a single channel. Do not generalize this behavior to


the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Real-IM) VI in a loop:

• labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based VIs

FFT Spectrum (Real-Im) for 1 Chan (CDB) VI


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
real and imaginary parts. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of

© National Instruments 1219


Functions

the averaging process.

• time signal —

time signal is the input time-domain waveform.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

1220 ni.com
Functions

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real part —

© National Instruments 1221


Functions

real part returns the real part of the averaged FFT spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

real part is the real part of the averaged FFT spectrum.

If the input signal is in volts (V), real part has units of volts-rms (Vrms). If the input signal is
not in volts, real part has units of the input signal unit-rms.

• imaginary part —

imaginary part returns the imaginary part of the averaged FFT spectrum and the frequency
scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imaginary part —

imaginary part is the imaginary part of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

1222 ni.com
Functions

The FFT Spectrum (Real-IM) VI completes the following steps to compute real part and
imaginary part:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the real and imaginary parts of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in


both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Real-IM) VI in a loop:

• labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based VIs

© National Instruments 1223


Functions

FFT Spectrum (Real-Im) for N Chan (CDB) VI


Computes the averaged FFT spectrum of time signal. This VI returns the FFT results as
real and imaginary parts. Wire data to the time signal input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals —

time signals is the input array of time-domain waveforms.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman

1224 ni.com
Functions

6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how this VI computes the averaging. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

© National Instruments 1225


Functions

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real parts —

real parts returns an array of the real part of the averaged FFT spectra, one per input waveform.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

1226 ni.com
Functions

real part is the real part of the averaged FFT spectrum.

If the input signal is in volts (V), real part has units of volts-rms (Vrms). If the input signal is
not in volts, real part has units of the input signal unit-rms.

• imaginary parts —

imaginary parts returns the imaginary part of the averaged FFT spectra and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imaginary part —

imaginary part is the imaginary part of the averaged FFT spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

The FFT Spectrum (Real-IM) VI completes the following steps to compute real part and
imaginary part:

1. Computes the FFT of time signal.


2. Averages the current FFT spectrum of time signal with the FFT spectra computed
by the VI since the last time the averaging process was reset.
3. Returns the real and imaginary parts of the averaged spectrum.

The single-channel version of this VI can perform single-channel measurements in

© National Instruments 1227


Functions

both one-shot mode, meaning a single call, and continuous mode, meaning multiple
calls with history. The single-channel version can perform multichannel
measurements only in one-shot mode. If you want to make multichannel
measurements in continuous mode, use the multichannel version of this VI.

The single-channel version of this VI maintains internal state information for a single
channel only. Calling the single-channel version to process another channel without
using the restart averaging control to clear the history results in an unexpected
behavior of this VI. The unexpected behavior results from the VI passing the internal
state information from one channel to another.

Note The single-channel version of this VI is intended primarily for


continuous processing of a single channel. Do not generalize this behavior to
the multichannel case and use the single-channel version in a For Loop to
continuously process multiple channels by indexing an array of waveforms.

Refer to the following LabVIEW project for examples of using a multichannel


version of a VI like the FFT Spectrum (Real-IM) VI in a loop:

• labview\examples\Signal Processing\Waveform
Measurements\Waveform Measurements.lvproj

Related Information

Output Units for FFT-Based VIs

Frequency Response Function (Mag-Phase)


Computes the frequency response and the coherence based on the input signals.
Results are returned as magnitude, phase, and coherence.

• Frequency Response Function (Mag-Phase) 1-1 VI

1228 ni.com
Functions

• Frequency Response Function (Mag-Phase) 1-N VI


• Frequency Response Function (Mag-Phase) N-1 VI
• Frequency Response Function (Mag-Phase) N-M VI

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Frequency Analysis of a Filter Design.vi

Frequency Response Function (Mag-Phase)


1-1 VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as magnitude, phase, and coherence.

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

© National Instruments 1229


Functions

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal X —

time signal X is the time waveform X.

• time signal Y —

time signal Y is the time waveform Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen

1230 ni.com
Functions

34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters defines how the averaging is computed. The specifications of the
parameters include the type of averaging, the type of weighting, and the number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

© National Instruments 1231


Functions

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

• averaging done —

1232 ni.com
Functions

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitude —

magnitude returns the magnitude of the averaged frequency response and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged frequency response.

• phase —

phase returns the phase of the averaged frequency response and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase is the phase of the averaged frequency response.

• coherence —

coherence returns the coherence and the frequency scale.

© National Instruments 1233


Functions

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Frequency Analysis of a Filter Design.vi

Frequency Response Function (Mag-Phase)


1-N VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as magnitude, phase, and coherence.

1234 ni.com
Functions

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal X —

time signal X is the time waveform X.

• time signals Y —

time signals Y is the array of time waveforms Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

© National Instruments 1235


Functions

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

1236 ni.com
Functions

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters defines how the averaging is computed. The specifications of the
parameters include the type of averaging, the type of weighting, and the number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

© National Instruments 1237


Functions

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitudes —

magnitudes returns an array of the magnitudes of the averaged frequency responses and the
frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged frequency response.

• phases —

phases returns an array of the phases of the averaged frequency responses and the frequency
scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

1238 ni.com
Functions

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase is the phase of the averaged frequency response.

• coherences —

coherences returns an array of the coherence functions of the averaged frequency responses
and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 1239


Functions

• labview\examples\Signal Processing\Waveform Measurements\


Frequency Analysis of a Filter Design.vi

Frequency Response Function (Mag-Phase)


N-1 VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as magnitude, phase, and coherence.

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals X —

1240 ni.com
Functions

time signals X is the array of time waveforms X.

• time signal Y —

time signal Y is the time waveform Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

© National Instruments 1241


Functions

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters defines how the averaging is computed. The specifications of the
parameters include the type of averaging, the type of weighting, and the number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

1242 ni.com
Functions

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitudes —

magnitudes returns an array of the magnitudes of the averaged frequency responses and the
frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

© National Instruments 1243


Functions

• magnitude —

magnitude is the magnitude of the averaged frequency response.

• phases —

phases returns an array of the phases of the averaged frequency responses and the frequency
scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase is the phase of the averaged frequency response.

• coherences —

coherences returns an array of the coherence functions of the averaged frequency responses
and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

1244 ni.com
Functions

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Frequency Analysis of a Filter Design.vi

Frequency Response Function (Mag-Phase)


N-M VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as magnitude, phase, and coherence.

Inputs/Outputs
• window parameter —

© National Instruments 1245


Functions

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals X —

time signals X is the array of time waveforms X.

• time signals Y —

time signals Y is the array of time waveforms Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall

1246 ni.com
Functions

30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters defines how the averaging is computed. The specifications of the
parameters include the type of averaging, the type of weighting, and the number of averages.

• averaging mode —

© National Instruments 1247


Functions

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

• X-Y pairing —

1248 ni.com
Functions

X-Y pairing specifies how to handle multiple signals in each input.

ordered pairs (default)—Calculates the frequency response of the first channel in time signals
X against the first channel in time signals Y, then the second channel in time signals X against
the second channel in time signals Y, and so on.
• If there is one channel in time signals X and one channel in time signals Y, the result is one
output.
• If there are multiple channels in time signals X and one channel in time signals Y, the
analysis result is the first channel in time signals X against the single channel in time
signals Y. LabVIEW ignores the rest of the channels in time signals X, and the VI returns a
warning.
0 • If there is one channel in time signals X and multiple channels in time signals Y, the
analysis result is the single channel in time signals X against the first channel in time
signals Y. LabVIEW ignores the rest of the channels in time signals Y, and the VI returns a
warning.
• If there are multiple channels in both time signals X and time signals Y, the analysis result
is the first channel in time signals X against the first channel in time signals Y, the second
channel in time signals X against the second channel in time signals Y, and so on. If there
is a mismatched number of channels, the VI ignores unmatched channels and returns a
warning.
• If either input signal is empty, the result is empty, and the VI returns an error.
all cross pairs—Calculates the frequency response of the first channel in time signals X against
each channel in time signals Y, then the second channel in time signals X against each channel
in time signals Y, and so on.
• If there is one channel in time signals X and one channel in time signals Y, the result is one
output.
• If there are multiple channels in time signals X and one channel in time signals Y, the
analysis result is the first channel in time signals X against the single channel in time
signals Y, then the second channel in time signals X against the single channel in time
1 signals Y, and so on. The output contains the same number of signals as time signals X.
• If there is one channel in time signals X and multiple channels in time signals Y, the
analysis result is the single channel in time signals X against the first channel in time
signals Y, then the single channel in time signals X against the second channel in time
signals Y, and so on. The output contains the same number of signals as time signals Y.
• If there are N channels in time signals X and M channels in time signals Y, the analysis
result is the matrix set of time signals X versus time signals Y. LabVIEW returns the signals
in the order 1 – 1, ..., 1 – M, 2 – 1, ..., 2 – M, ..., N – M.
• If either input signal is empty, the result is empty, and the VI returns an error.

• averaging done —

© National Instruments 1249


Functions

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitudes —

magnitudes returns an array of the magnitudes of the averaged frequency responses and the
frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged frequency response.

• phases —

phases returns an array of the phases of the averaged frequency responses and the frequency
scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase is the phase of the averaged frequency response.

• coherences —

coherences returns an array of the coherence functions of the averaged frequency responses

1250 ni.com
Functions

and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Frequency Analysis of a Filter Design.vi

Frequency Response Function (Real-Im)


Computes the frequency response and the coherence based on the input signals.
Results are returned as real part, imaginary part, and coherence.

© National Instruments 1251


Functions

• Frequency Response Function (Real-Im) 1-1 VI


• Frequency Response Function (Real-Im) 1-N VI
• Frequency Response Function (Real-Im) N-1 VI
• Frequency Response Function (Real-Im) N-M VI

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Nyquist Plot of a Filter.vi

Frequency Response Function (Real-Im) 1-1


VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as real part, imaginary part, and coherence.

Inputs/Outputs
• window parameter —

1252 ni.com
Functions

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal X —

time signal X is the time waveform X.

• time signal Y —

time signal Y is the time waveform Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall

© National Instruments 1253


Functions

30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how the averaging is computed. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

1254 ni.com
Functions

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real part —

real part returns the real part of the averaged frequency response and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

© National Instruments 1255


Functions

real part is the real part of the averaged frequency response.

• imaginary part —

imaginary part returns the imaginary part of the averaged frequency response and the
frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imaginary part —

imaginary part is the imaginary part of the averaged frequency response.

• coherence —

coherence returns the coherence and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

1256 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Nyquist Plot of a Filter.vi

Frequency Response Function (Real-Im) 1-N


VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as real part, imaginary part, and coherence.

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

© National Instruments 1257


Functions

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal X —

time signal X is the time waveform X.

• time signals Y —

time signals Y is the array of time waveforms Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen

1258 ni.com
Functions

34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how the averaging is computed. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

© National Instruments 1259


Functions

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real parts —

real parts returns an array of the real parts of the averaged frequency responses and the
frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

real part is the real part of the averaged frequency response.

• imaginary parts —

imaginary parts returns an array of the imaginary parts of the averaged frequency responses

1260 ni.com
Functions

and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imag part —

imaginary part is the imaginary part of the averaged frequency response.

• coherences —

coherences returns an array of the coherence functions of the averaged frequency responses
and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.

© National Instruments 1261


Functions

Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Nyquist Plot of a Filter.vi

Frequency Response Function (Real-Im) N-1


VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as real part, imaginary part, and coherence.

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart

1262 ni.com
Functions

averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals X —

time signals X is the array of time waveforms X.

• time signal Y —

time signal Y is the time waveform Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

© National Instruments 1263


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how the averaging is computed. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

1264 ni.com
Functions

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real parts —

real parts returns an array of the real parts of the averaged frequency responses and the
frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

real part is the real part of the averaged frequency response.

• imaginary parts —

imaginary parts returns an array of the imaginary parts of the averaged frequency responses
and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

© National Instruments 1265


Functions

df returns the frequency resolution, in hertz, of the spectrum.

• imag part —

imaginary part is the imaginary part of the averaged frequency response.

• coherences —

coherences returns an array of the coherence functions of the averaged frequency responses
and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

1266 ni.com
Functions

• labview\examples\Signal Processing\Waveform Measurements\


Nyquist Plot of a Filter.vi

Frequency Response Function (Real-Im) N-M


VI
Computes the frequency response and the coherence based on the input signals.
Results are returned as real part, imaginary part, and coherence.

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signals X —

© National Instruments 1267


Functions

time signals X is the array of time waveforms X.

• time signals Y —

time signals Y is the array of time waveforms Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters is a cluster that defines how the averaging is computed. The
specifications of the parameters include the type of averaging, the type of weighting, and the
number of averages.

1268 ni.com
Functions

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• FRF Mode —

FRF mode specifies how to compute the frequency response function (FRF).

If you know that noise, which does not propagate through the system under test, infiltrates the
input or output signals, you can select the method used for computing the frequency response
function (H1, H2, H3) to minimize the measurement error.

H1 (default)—Select H1 to minimize errors in the result when extraneous noise contaminates


0
the output signal.
H2—Select H2 to minimize errors in the result when extraneous noise contaminates the input
1
signal.
H3—When noise contaminates both the input and output signals, H1 and H2 provide the lower
2 and upper bounds of the true frequency response of the system. In this case, select H3, the
average of H1 and H2.

© National Instruments 1269


Functions

• X-Y pairing —

X-Y pairing specifies how to handle multiple signals in each input.

ordered pairs (default)—Calculates the frequency response of the first channel in time signals
X against the first channel in time signals Y, then the second channel in time signals X against
the second channel in time signals Y, and so on.
• If there is one channel in time signals X and one channel in time signals Y, the result is one
output.
• If there are multiple channels in time signals X and one channel in time signals Y, the
analysis result is the first channel in time signals X against the single channel in time
signals Y. LabVIEW ignores the rest of the channels in time signals X, and the VI returns a
warning.
0 • If there is one channel in time signals X and multiple channels in time signals Y, the
analysis result is the single channel in time signals X against the first channel in time
signals Y. LabVIEW ignores the rest of the channels in time signals Y, and the VI returns a
warning.
• If there are multiple channels in both time signals X and time signals Y, the analysis result
is the first channel in time signals X against the first channel in time signals Y, the second
channel in time signals X against the second channel in time signals Y, and so on. If there
is a mismatched number of channels, the VI ignores unmatched channels and returns a
warning.
• If either input signal is empty, the result is empty, and the VI returns an error.
all cross pairs—Calculates the frequency response of the first channel in time signals X against
each channel in time signals Y, then the second channel in time signals X against each channel
in time signals Y, and so on.
• If there is one channel in time signals X and one channel in time signals Y, the result is one
output.
• If there are multiple channels in time signals X and one channel in time signals Y, the
analysis result is the first channel in time signals X against the single channel in time
signals Y, then the second channel in time signals X against the single channel in time
1 signals Y, and so on. The output contains the same number of signals as time signals X.
• If there is one channel in time signals X and multiple channels in time signals Y, the
analysis result is the single channel in time signals X against the first channel in time
signals Y, then the single channel in time signals X against the second channel in time
signals Y, and so on. The output contains the same number of signals as time signals Y.
• If there are N channels in time signals X and M channels in time signals Y, the analysis
result is the matrix set of time signals X versus time signals Y. LabVIEW returns the signals
in the order 1 – 1, ..., 1 – M, 2 – 1, ..., 2 – M, ..., N – M.
• If either input signal is empty, the result is empty, and the VI returns an error.

• averaging done —

1270 ni.com
Functions

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real parts —

real parts returns an array of the real parts of the averaged frequency responses and the
frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

real part is the real part of the averaged frequency response.

• imaginary parts —

imaginary parts returns an array of the imaginary parts of the averaged frequency responses
and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imag part —

imaginary part is the imaginary part of the averaged frequency response.

• coherences —

coherences returns an array of the coherence functions of the averaged frequency responses

© National Instruments 1271


Functions

and the frequency scales.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• coherence —

coherence returns the coherence.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Signal Processing\Waveform Measurements\


Nyquist Plot of a Filter.vi

Cross Spectrum (Mag-Phase)


Computes the averaged cross power spectrum of the input signals. Results are
returned as magnitude and phase.

1272 ni.com
Functions

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal X —

time signal X is the time waveform X.

• time signal Y —

time signal Y is the time waveform Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

© National Instruments 1273


Functions

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• view —

view defines how the different results from this VI are returned.

• dB On (F) —

dB On specifies whether the results are expressed in decibels. The default is FALSE.

• unwrap phase (F) —

unwrap phase specifies whether to unwrap the phase. Unwrapping eliminates


discontinuities that have an absolute value greater than pi. The default is FALSE, meaning
the phase is not unwrapped.

When unwrap phase is TRUE, the phase is unwrapped.

• convert to degree (F) —

convert to degree specifies whether the phase results are converted from radians to
degrees. The default is FALSE, which means that results are expressed in radians.

1274 ni.com
Functions

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters defines how the averaging is computed. The specifications of the
parameters include the type of averaging, the type of weighting, and the number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• magnitude —

© National Instruments 1275


Functions

magnitude returns the magnitude of the averaged cross power spectrum and the frequency
scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• magnitude —

magnitude is the magnitude of the averaged cross power spectrum.

• phase —

phase returns the phase of the averaged cross power spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• phase —

phase returns the phase of the averaged cross power spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.

1276 ni.com
Functions

Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Cross Spectrum (Real-Im)


Computes the averaged cross power spectrum of the input signals. Results are
returned as real and imaginary parts.

Inputs/Outputs
• window parameter —

window parameter specifies the beta parameter for a Kaiser window, the standard deviation for
a Gaussian window, and the ratio, s, of the main lobe to the side lobe for a Dolph-Chebyshev
window. If window is any other window, this VI ignores this input.

The default value of window parameter is NaN, which sets beta to 0 for a Kaiser window, the
standard deviation to 0.2 for a Gaussian window, and s to 60 for a Dolph-Chebyshev window.

• restart averaging (F) —

restart averaging specifies whether the VI restarts the selected averaging process. If restart
averaging is TRUE, the VI restarts the selected averaging process. If restart averaging is FALSE,
the VI does not restart the selected averaging process. The default is FALSE.

When you call this VI for the first time, the averaging process restarts automatically. A typical
case when you should restart averaging is when a major input change occurs in the middle of
the averaging process.

• time signal X —

time signal X is the time waveform X.

• time signal Y —

© National Instruments 1277


Functions

time signal Y is the time waveform Y.

• window —

window (Hanning) is the time-domain window to apply to the time signal. The default window
is Hanning.

0 Rectangle
1 Hanning (default)
2 Hamming
3 Blackman-Harris
4 Exact Blackman
5 Blackman
6 Flat Top
7 4 Term B-Harris
8 7 Term B-Harris
9 Low Sidelobe
11 Blackman Nutall
30 Triangle
31 Bartlett-Hanning
32 Bohman
33 Parzen
34 Welch
60 Kaiser
61 Dolph-Chebyshev
62 Gaussian

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• averaging parameters —

averaging parameters defines how the averaging is computed. The specifications of the
parameters include the type of averaging, the type of weighting, and the number of averages.

• averaging mode —

averaging mode specifies the averaging mode.

1278 ni.com
Functions

No averaging
0
(default)
1 Vector averaging
2 RMS averaging
3 Peak hold

• weighting mode —

weighting mode specifies the weighting mode for RMS and vector averaging.

0 Linear
Exponential
1
(default)

• number of averages —

number of averages specifies the number of averages used for RMS and vector averaging. If
weighting mode is exponential, the averaging process is continuous. If weighting mode is
linear, the averaging process stops after this VI computes the selected number of averages.

• averaging done —

averaging done returns TRUE when averages completed is greater than or equal to the number
of averages specified in averaging parameters. Otherwise, averaging done returns FALSE.
averaging done is always TRUE if the selected averaging mode is No averaging.

• real part —

real part returns the real part of the averaged cross power spectrum and the frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• real part —

© National Instruments 1279


Functions

real part is the real part of the averaged cross power spectrum.

• imaginary part —

imaginary part returns the imaginary part of the averaged cross power spectrum and the
frequency scale.

• f0 —

f0 returns the start frequency, in hertz, of the spectrum.

• df —

df returns the frequency resolution, in hertz, of the spectrum.

• imaginary part —

imaginary part is the imaginary part of the averaged cross power spectrum.

• averages completed —

averages completed returns the number of averages completed by the VI at that time.

• error out —

error out contains error information. This output provides standard error out functionality.

Typically, time signal X is the stimulus, and time signal Y is the response of the system.
Each time waveform corresponds to a single FFT block. You have to pass each time
waveform individually to this VI.

Spectral Measurements
Performs FFT-based spectral measurements, such as the averaged magnitude
spectrum, power spectrum, and phase spectrum on a signal.

1280 ni.com
Functions

Dialog Box Options

Option Description
Contains the following options:

• Magnitude (peak)—

Measures the spectrum and displays the results in terms of peak amplitude.

You typically use this measurement with more advanced measurements that
require magnitude and phase information. The magnitude of the spectrum is
measured in peak values. For example, a sine tone of amplitude A yields a
magnitude spectral value of A at the sine tone frequency. You can unwrap the
phase spectrum or convert it from radians to degrees by setting Phase to
Unwrap phase or Convert to degree, respectively. If you place a checkmark in
the Averaging checkbox, the phase of the spectrum is zero for averaging.

• Magnitude (RMS)—
Selected
Measures the spectrum and displays the results in terms of root-mean-square
Measurement
(RMS).

You typically use this measurement with more advanced measurements that
require magnitude and phase information. The magnitude of the spectrum is
measured in RMS values. For example, a sine tone of amplitude A yields a
magnitude spectral value of 0.707*A at the sine tone frequency. You can
unwrap the phase spectrum or convert it from radians to degrees by setting
Phase to Unwrap phase or Convert to degree, respectively. If you place a
checkmark in the Averaging checkbox, the phase of the spectrum is zero for
averaging.

• Power spectrum—

Measures the spectrum and displays the results in terms of power. All phase
information is lost in the computation.

© National Instruments 1281


Functions

Option Description

You typically use this measurement to examine the various frequency


components of a signal. While averaging to compute a power spectrum does
not reduce the unwanted noise in a system, averaging is useful because it
provides a reliable statistical estimate of the level of random signals measured.

• Power spectral density—

Measures the spectrum and displays the results in terms of power spectral
density (PSD).

Power spectral density is a scaled version of Power spectrum, where the


power present within each spectral bin is normalized by the frequency bin
width. You typically use this measurement to examine the noise floor of a
signal or the power in a specific frequency range. Normalizing the power
spectrum by the bin width makes this measurement independent of the signal
duration, or number of samples.

Contains the following options:

• Linear—

Returns the results in terms of the original units.


Result
• dB—

Returns the results in terms of decibels (dB).

Specifies the window to apply to the signal.

• None does not apply a window to Signals.


• Hanning applies a Hanning window to Signals.
• Hamming applies a Hamming window to Signals.
• Blackman-Harris applies a Blackman-Harris window to Signals.
Window
• Exact Blackman applies an exact Blackman window to Signals.
• Blackman applies a Blackman window to Signals.
• Flat Top applies a Flat Top window to Signals.
• 4 Term B-Harris applies a Four Term Blackman-Harris window to Signals.
• 7 Term B-Harris applies a Seven Term Blackman-Harris window to Signals.
• Low Sidelobe applies a Low Sidelobe window to Signals.

1282 ni.com
Functions

Option Description
Refer to the Scaled Time Domain Window VI for information about coefficients and
window parameters for each window type.

Averaging Specifies whether the Express VI performs averaging.

Contains the following options:

• Peak hold—

Performs averaging at each frequency line separately, retaining peak levels


from one FFT record to the next.

• Vector—
Mode
Computes the average of complex FFT spectrum quantities directly. Vector
averaging eliminates noise from synchronous signals.

• RMS—

Averages the energy, or power, of the FFT spectrum of the signal.

Contains the following options:

• Linear—

Returns the results in terms of the original units.

Weighting • Exponential—

Specifies exponential averaging, which averages over the number of packets


you specify in Number of Averages in a weighted manner. Exponential
averaging gives the most recent packets more weighting in the average than
older packets.

Number of
Specifies the number of packets to average. The default is 10.
Averages

Contains the following options:


Produce
Spectrum • Every iteration—

© National Instruments 1283


Functions

Option Description

Returns the spectrum after every iteration of the Express VI.

• Only when averaging complete—

Returns the spectrum only after the Express VI gathers the number of packets
you specify in Number of Averages.

Contains the following options:

• Unwrap phase—

Enables phase unwrapping on the output phase.


Phase
• Convert to degree—

Returns the phase in degrees.

Displays the first channel of Signals. This graph displays the incoming signal with
windowing applied.
Windowed
Input Signal If you wire data to the Express VI and run it, Windowed Input Signal displays real
data. If you close and reopen the Express VI, Windowed Input Signal displays
sample data until you run the VI again.

Displays a preview of the magnitude measurement of the signal.


Magnitude
Result If you wire data to the Express VI and run it, Magnitude Result Preview displays real
Preview data. If you close and reopen the Express VI, Magnitude Result Preview displays
sample data until you run the VI again.

Contains the following options:


Phase Result
If you wire data to the Express VI and run it, Phase Result Preview displays real
Preview
data. If you close and reopen the Express VI, Phase Result Preview displays sample
data until you run the VI again.

1284 ni.com
Functions

Inputs/Outputs
• Restart Averaging — Specifies whether to restart the selected averaging process. The
default is FALSE. When you call this Express VI for the first time, the averaging process starts
automatically.

This input appears only if you place a checkmark in the Averaging checkbox.

• error in (no error) —


Describes error conditions that occur before this node runs.
• Signals —
Contains the input signal or signals.
• error out —
Contains error information. This output provides standard error out functionality.
• FFT - (RMS) — Returns the FFT magnitude spectrum and displays the results in RMS units.
• Power Spectrum — Returns the FFT power spectrum and displays the results in RMS-
squared units.

To compute the FFT power spectrum, LabVIEW converts the two-sided power spectrum to the
single-sided power spectrum.

• PSD — Returns the FFT power spectral density and displays the results in RMS-squared per
Hz units.
• FFT - (Peak) — Returns the FFT magnitude spectrum and displays the results in peak units.
• averaging done — Returns TRUE when the number of averages completed equals or
exceeds Number of Averages.
• Phase —
Returns the FFT phase spectrum and displays the results in degrees or radians.

• f0 —

• df —

• phase —

FFT-based spectral computations assume that the finite block of signal data represents
one period of a periodic signal. The computed spectrum of this effective periodically
extended signal shows energy spreading into frequencies that were not present in the
original signal. To reduce this spectral leakage, use smoothing windows to taper the
sharp transitions in the effective signal. You do not typically use windows if you can
acquire an integer number of cycles of each frequency component measured or if you

© National Instruments 1285


Functions

are analyzing noise spectra.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Express VIs\Express VI - Spectral


Measurements.vi
• labview\examples\Express VIs\Express VI - Filter.vi

Components

Returns TRUE when the number of averages completed equals or exceeds Number of
Averages.

Describes error conditions that occur before this node runs.

Specifies whether to restart the selected averaging process. The default is FALSE. When
you call this Express VI for the first time, the averaging process starts automatically.

Measures the spectrum and displays the results in terms of power spectral density
(PSD).

Measures the spectrum and displays the results in terms of power. All phase
information is lost in the computation.

Measures the spectrum and displays the results in terms of root-mean-square (RMS).

Measures the spectrum and displays the results in terms of peak amplitude.

Specifies whether the Express VI performs averaging.

Contains the following options:

Enables phase unwrapping on the output phase.

Returns the phase in degrees.

Specifies the number of packets to average. The default is 10.

1286 ni.com
Functions

Specifies the number of packets to average. The default is 10.

Specifies the window to apply to the signal.

Displays the first channel of Signals. This graph displays the incoming signal with
windowing applied.

Contains the input signal or signals.

Contains error information. This output provides standard error out functionality.

Displays a preview of the magnitude measurement of the signal.

Contains the following options:

Returns the results in terms of the original units.

Returns the results in terms of decibels (dB).

Contains the following options:

Specifies linear averaging, which averages over the number of packets you specify in
Number of Averages in a non-weighted manner.

Specifies exponential averaging, which averages over the number of packets you
specify in Number of Averages in a weighted manner. Exponential averaging gives the
most recent packets more weighting in the average than older packets.

Contains the following options:

Returns the spectrum after every iteration of the Express VI.

Returns the spectrum only after the Express VI gathers the number of packets you
specify in Number of Averages.

Contains the following options:

Computes the average of complex FFT spectrum quantities directly. Vector averaging
eliminates noise from synchronous signals.

© National Instruments 1287


Functions

Averages the energy, or power, of the FFT spectrum of the signal.

Performs averaging at each frequency line separately, retaining peak levels from one
FFT record to the next.

Dual Channel Spectral Measurement


Measures the frequency response of the input signals and the coherence based on the
current and previous input signals. This Express VI returns results such as Magnitude,
Phase, Coherence, Real, and Imaginary.

Dialog Box Options

Option Description
Specifies how to handle multiple signals in each input.

• Ordered pairs—

Calculates the frequency response of the first channel in Input Signal A against
the first channel in Input Signal B, then the second channel in Input Signal A
against the second channel in Input Signal B, and so on.

◦ If there is one channel on Input Signal A and one channel on Input Signal B,
the result is one output.
Input ◦ If there are multiple channels on Input Signal A and one channel on Input
Comparison Signal B, the analysis result is the first channel in Input Signal A against the
single channel in Input Signal B. The rest of the channels in Input Signal A
are ignored and the VI returns a warning.
◦ If there is one channel on Input Signal A and multiple channels on Input
Signal B, the analysis result is the single channel in Input Signal A against
the first channel in Input Signal B. The rest of the channels in Input Signal B
are ignored and the VI returns a warning.
◦ If there are multiple channels on both Input Signal A and Input Signal B, the
analysis result is the first channel in Input Signal A against the first channel

1288 ni.com
Functions

Option Description

in Input Signal B, the second channel in Input Signal A against the second
channel in Input Signal B, and so on. If there is a mismatched number of
channels, the VI ignores unmatched channels and returns a warning.
◦ If either Input Signal is empty, the result is empty and the VI returns an error.
• All cross pairs—

Calculates the frequency response of the first channel in Input Signal A against
each channel in Input Signal B, then the second channel in Input Signal A
against each channel in Input Signal B, and so on.

◦ If there is one channel on Input Signal A and one channel on Input Signal B,
the result is one output.
◦ If there are multiple channels on Input Signal A and one channel on Input
Signal B, the analysis result is the first channel in Input Signal A against the
single channel in Input Signal B, then the second channel in Input Signal A
against the single channel in Input Signal B, and so on. The output contains
the same number of signals as Input Signal A.
◦ If there is one channel on Input Signal A and multiple channels on Input
Signal B, the analysis result is the single channel in Input Signal A against
the first channel in Input Signal B, then the single channel in Input Signal A
against the second channel in Input Signal B, and so on. The output
contains the same number of signals as Input Signal B.
◦ If there are M channels on Input Signal A and N channels on Input Signal B,
the analysis result is the matrix set of Input Signal A versus Input Signal B.
The signals are returned in the order 1-1, ... 1-N, 2-1, ... M-N.
◦ If either Input Signal is empty, the result is empty and the VI returns an error.

Contains the following options:

• Magnitude—

Select to include magnitude results in the output.


Frequency
Response ◦ dB—
Function
Select to return the magnitude results in decibels. Remove the checkmark
from this checkbox to return the magnitude results in the original units.

• Phase—

© National Instruments 1289


Functions

Option Description

Select to include phase results in the output. Select Unwrap phase to return the
phase results in radians. Select Convert to degree to return the phase results in
degrees.

◦ Unwrap phase—

Select to return the phase results in radians.

◦ Convert to degree—

Select to return the phase results in degrees.

• Real—

Select to include real results in the output.

• Imaginary—

Select to include imaginary results in the output.

• Coherence—

Select to include coherence results in the output.

Specifies the window to apply to the signal.

• None does not apply a window to Signals.


• Hanning applies a Hanning window to Signals.
• Hamming applies a Hamming window to Signals.
• Blackman-Harris applies a Blackman-Harris window to Signals.
• Exact Blackman applies an exact Blackman window to Signals.
Window
• Blackman applies a Blackman window to Signals.
• Flat Top applies a Flat Top window to Signals.
• 4 Term B-Harris applies a Four Term Blackman-Harris window to Signals.
• 7 Term B-Harris applies a Seven Term Blackman-Harris window to Signals.
• Low Sidelobe applies a Low Sidelobe window to Signals.

Refer to the Scaled Time Domain Window VI for information about coefficients and
window parameters for each window type.

1290 ni.com
Functions

Option Description

Averaging Specifies whether the Express VI performs averaging.

Contains the following options:

• Vector—

Computes the average of complex quantities directly.


Mode
• RMS—

Averages the energy, or power, of the signal.

Contains the following options:

• Linear—

Specifies linear averaging, which averages over the number of packets you
specify in Number of Averages in a non-weighted manner.
Weighting
• Exponential—

Specifies exponential averaging, which averages over the number of packets you
specify in Number of Averages in a weighted manner. Exponential averaging
gives the most recent packets more weighting in the average than older packets.

Number of
Specifies the number of packets to average. The default is 10.
Averages

Contains the following options:

• Every iteration—

Returns the spectrum after every iteration of the Express VI.


Produce
Spectrum
• Only when averaging complete—

Returns the spectrum only after the Express VI gathers the number of packets
you specify in Number of Averages.

© National Instruments 1291


Functions

Option Description

Displays the first channel of Input Signal A. This graph displays the first incoming
signal with windowing applied.
Windowed
Input Signal
If you wire data to the Express VI and run it, Windowed Input Signal A displays real
A
data. If you close and reopen the Express VI, Windowed Input Signal A displays
sample data until you run the VI again.

Displays the first channel of Input Signal B. This graph displays the second incoming
signal with windowing applied.
Windowed
Input Signal
If you wire data to the Express VI and run it, Windowed Input Signal B displays real
B
data. If you close and reopen the Express VI, Windowed Input Signal B displays
sample data until you run the VI again.

If you wire data to the Express VI and run it, Results displays real data. If you close
and reopen the Express VI, Results displays sample data until you run the VI again.

• Magnitude—

Select to include magnitude results in the output.

This page appears only if you place a checkmark in the Magnitude checkbox.

• Phase—

Select to include phase results in the output. Select Unwrap phase to return the
Results
phase results in radians. Select Convert to degree to return the phase results in
degrees.

This page appears only if you place a checkmark in the Phase checkbox.

• Real—

Select to include real results in the output.

This page appears only if you place a checkmark in the Real checkbox.

• Imaginary—

1292 ni.com
Functions

Option Description

Select to include imaginary results in the output.

This page appears only if you place a checkmark in the Imaginary checkbox.

• Coherence—

Select to include coherence results in the output.

This page appears only if you place a checkmark in the Coherence checkbox.

Inputs/Outputs
• Input Signal A —

Contains the first input signal or signals. This is assumed to be the excitation. The input signals
must have the same number of data points, t0, and dt. If they do not, an error is returned.

• error in (no error) —

Describes error conditions that occur before this node runs.

• Restart Averaging (F) —

Specifies whether to restart the selected averaging process. The default is FALSE. When you call
this Express VI for the first time, the averaging process starts automatically.

This input appears only if you place a checkmark in the Averaging checkbox.

• Input Signal B —

Contains the second input signal or signals. This is assumed to be the response. The input
signals must have the same number of data points, t0, and dt. If they do not, an error is returned.

• Magnitude —

The magnitude from the frequency response calculations.

This output appears only if you place a checkmark in the Magnitude checkbox.

• Imaginary —

© National Instruments 1293


Functions

The imaginary part from the frequency response calculations.

This output appears only if you place a checkmark in the Imaginary checkbox.

• Real —

The real part from the frequency response calculations.

This output appears only if you place a checkmark in the Real checkbox.

• Averaging Done —

Returns TRUE when the number of averages completed equals or exceeds Number of Averages.

This output appears only if you place a checkmark in the Averaging checkbox.

• Coherence —

The coherence from the frequency response calculations.

This output appears only if you place a checkmark in the Coherence checkbox.

• error out —

Contains error information. This output provides standard error out functionality.

• Phase —

The phase from the frequency response calculations.

This output appears only if you place a checkmark in the Phase checkbox.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Express VIs\Express VI - Dual Channel


Spectral Measurement.vi

Components

Calculates the frequency response of the first channel in Input Signal A against each

1294 ni.com
Functions

channel in Input Signal B, then the second channel in Input Signal A against each
channel in Input Signal B, and so on.

Specifies the number of packets to average. The default is 10.

Select to include magnitude results in the output.

Calculates the frequency response of the first channel in Input Signal A against the
first channel in Input Signal B, then the second channel in Input Signal A against the
second channel in Input Signal B, and so on.

Select to include imaginary results in the output.

Select to include real results in the output.

Returns the spectrum after every iteration of the Express VI.

Select to include coherence results in the output.

Specifies the window to apply to the signal.

Select to return the magnitude results in decibels. Remove the checkmark from this
checkbox to return the magnitude results in the original units.

Specifies the number of packets to average. The default is 10.

Select to return the phase results in radians.

Select to return the phase results in degrees.

Displays the first channel of Input Signal A. This graph displays the first incoming
signal with windowing applied.

Specifies exponential averaging, which averages over the number of packets you
specify in Number of Averages in a weighted manner. Exponential averaging gives the
most recent packets more weighting in the average than older packets.

Specifies whether the Express VI performs averaging.

© National Instruments 1295


Functions

Select to include phase results in the output.

Displays a preview of the phase measurement of the signals.

Returns the spectrum only after the Express VI gathers the number of packets you
specify in Number of Averages.

Displays the first channel of Input Signal B. This graph displays the second incoming
signal with windowing applied.

If you wire data to the Express VI and run it, Results displays real data. If you close and
reopen the Express VI, Results displays sample data until you run the VI again.

Select to include phase results in the output. Select Unwrap phase to return the phase
results in radians. Select Convert to degree to return the phase results in degrees.

Computes the average of complex quantities directly.

Averages the energy, or power, of the signal.

Specifies linear averaging, which averages over the number of packets you specify in
Number of Averages in a non-weighted manner.

Distortion Measurements
Performs distortion measurements on a signal, such as tone analysis, total harmonic
distortion (THD), and signal in noise and distortion (SINAD).

Dialog Box Options

Option Description
Distortion Contains the following options:

1296 ni.com
Functions

Option Description

• SINAD (dB)—

Calculates the measured signal in noise and distortion (SINAD). SINAD is defined
as the dB of the ratio of the RMS energy of Signals to the RMS energy of Signals
less the energy in the fundamental. To compute the THD Plus Noise in dB, negate
the SINAD.

• Total harmonic distortion—

Computes the measured total harmonic distortion up to and including the highest
harmonic. THD is defined as the ratio of the RMS sum of the harmonics to the
amplitude of the fundamental tone. To compute THD as a percentage, multiply it
by 100.

• Specific harmonic level—

Returns the harmonic you specify.

• Harmonic number (fundamental = 1)—

Specifies the harmonic to measure. This option is available only when you select
Specific harmonic level.

• Stop search at Nyquist—

Specifies to include only frequencies less than the Nyquist frequency, or half the
sampling rate, in the harmonic search. This option is available only when you
select Total harmonic distortion or Specific harmonic level.

When you remove the checkmark from the Stop search at Nyquist checkbox, this
VI continues searching the frequency domain beyond the Nyquist frequency by
assuming that the higher frequency components have aliased according to the
following equation: aliased f = Fs – (f modulo Fs) where Fs = 1/dt = sampling rate

• Highest harmonic—

Controls the highest harmonic, including the fundamental tone, to use for the
harmonic analysis. For example, for third harmonic analysis, set Highest
harmonic to 3 to measure the fundamental, second, and third harmonic. This
option is available only when you select Total harmonic distortion or Specific
harmonic level.

© National Instruments 1297


Functions

Option Description
Contains the following options:

• Search for fundamental frequency—

Controls the frequency domain search area, which is the center frequency and
width, to use for finding the fundamental tone frequency of the signal.

◦ Approximate frequency—

Center frequency to use in the frequency domain search for the fundamental
Search tone frequency. The default is 0. If you set Approximate frequency to –1, this
Frequency Express VI uses the tone with the highest amplitude as the fundamental tone.
This option is available only when you place a checkmark in the Search for
fundamental frequency checkbox.

◦ Search (+/- % of approx. freq.)—

Frequency width, as a percentage of the sampling rate, to use for the


frequency domain search for the fundamental tone frequency. The default is
5. This option is available only when you place a checkmark in the Search for
fundamental frequency checkbox.

Displays the measurements you configured this Express VI to perform and the
calculated values of those measurements. You can click any measurement listed in the
Results
Measurement column, and the corresponding value or plot appears in the Result
Preview graph.

Displays the input signal.


Input
If you wire data to the Express VI and run it, Input Signal displays real data. If you close
Signal
and reopen the Express VI, Input Signal displays sample data until you run the Express
VI again.

Displays a preview of the measurement. The Result Preview plot indicates the value of
Result the selected measurement with a dotted line.
Preview
If you wire data to the Express VI and run the VI, Result Preview displays real data. If

1298 ni.com
Functions

Option Description

you close and reopen the Express VI, Result Preview displays sample data until you run
the VI again. If the cutoff frequency values are invalid, Result Preview does not display
valid data.

Inputs/Outputs
• Signals —

Contains the input signal or signals.

• error in (no error) —

Describes error conditions that occur before this node runs.

• error out —

Contains error information. This output provides standard error out functionality.

• SINAD (dB) —

Returns the measured signal in noise and distortion (SINAD). SINAD is defined as the dB of the
ratio of the RMS energy of Signals to the RMS energy of Signals less the energy in the
fundamental. To compute the THD Plus Noise in dB, negate the SINAD.

• Specific Harmonic —

Returns the harmonic you specify in Specific harmonic level.

• THD —

Returns the measured total harmonic distortion up to and including the highest harmonic. To
compute THD as a percentage, you must multiply it by 100.

Components

Displays the measurements you configured this Express VI to perform and the
calculated values of those measurements. You can click any measurement listed in the
Measurement column, and the corresponding value or plot appears in the Result

© National Instruments 1299


Functions

Preview graph.

Specifies the harmonic to measure. This option is available only when you select
Specific harmonic level.

Controls the highest harmonic, including the fundamental tone, to use for the
harmonic analysis. For example, for third harmonic analysis, set Highest harmonic to
3 to measure the fundamental, second, and third harmonic. This option is available
only when you select Total harmonic distortion or Specific harmonic level.

Controls the frequency domain search area, which is the center frequency and width,
to use for finding the fundamental tone frequency of the signal.

Frequency width, as a percentage of the sampling rate, to use for the frequency
domain search for the fundamental tone frequency. The default is 5. This option is
available only when you place a checkmark in the Search for fundamental frequency
checkbox.

Center frequency to use in the frequency domain search for the fundamental tone
frequency. The default is 0. If you set Approximate frequency to –1, this Express VI
uses the tone with the highest amplitude as the fundamental tone. This option is
available only when you place a checkmark in the Search for fundamental frequency
checkbox.

Calculates the measured signal in noise and distortion (SINAD). SINAD is defined as the
dB of the ratio of the RMS energy of Signals to the RMS energy of Signals less the
energy in the fundamental. To compute the THD Plus Noise in dB, negate the SINAD.

Returns the harmonic you specify.

Computes the measured total harmonic distortion up to and including the highest
harmonic. THD is defined as the ratio of the RMS sum of the harmonics to the
amplitude of the fundamental tone. To compute THD as a percentage, multiply it by
100.

Displays a preview of the measurement. The Result Preview plot indicates the value of
the selected measurement with a dotted line.

1300 ni.com
Functions

Displays the input signal.

Specifies to include only frequencies less than the Nyquist frequency, or half the
sampling rate, in the harmonic search. This option is available only when you select
Total harmonic distortion or Specific harmonic level.

Tone Measurements
Finds the single tone with the highest amplitude or searches a specified frequency
range to find the single tone with the highest amplitude. You also can find the
frequency and phase for a single tone.

Dialog Box Options

Option Description
Contains the following options:

• Amplitude—

Calculates the amplitude of the detected single tone in volts peak (Vp).

Single Tone • Frequency—


Measurements
Calculates the frequency of the detected single tone in Hertz.

• Phase—

Calculates the phase of the detected single tone in degrees.

Contains the following options:


Search for
• Approximate frequency (Hz)—
Specific
Frequency
Center frequency to use in the frequency domain search for the single tone.

© National Instruments 1301


Functions

Option Description

The default is 10. This option is available only when you place a checkmark in
the Search for Specific Frequency checkbox.

• Search (+/- % of approx. freq.)—

Frequency width, as a percentage of the sampling rate, for the frequency


domain search for the single tone frequency. The default is 5. This option is
available only when you place a checkmark in the Search for Specific
Frequency checkbox.

Displays the measurements you configured this Express VI to perform and the
calculated values of those measurements. You can click any measurement listed in
Results
the Measurement column, and the corresponding value or plot appears in the
Result Preview graph.

Displays the input signal.

Input Signal If you wire data to the Express VI and run it, Input Signal displays real data. If you
close and reopen the Express VI, Input Signal displays sample data until you run
the Express VI again.

Displays a preview of the measurement. The Result Preview plot indicates the
value of the selected measurement with a dotted line.
Result
If you wire data to the Express VI and run the VI, Result Preview displays real data.
Preview
If you close and reopen the Express VI, Result Preview displays sample data until
you run the VI again. If the cutoff frequency values are invalid, Result Preview does
not display valid data.

Center frequency to use in the frequency domain search for the single tone. The
Approximate
default is 10. This option is available only when you place a checkmark in the
frequency (Hz)
Search for Specific Frequency checkbox.

1302 ni.com
Functions

Inputs/Outputs
• Signals —

Contains the input signal or signals.

• error in (no error) —

Describes error conditions that occur before this node runs.

• error out —

Contains error information. This output provides standard error out functionality.

• Phase —

Returns the phase of the detected single tone in degrees.

• Frequency —

Returns the frequency of the detected single tone in Hertz.

• Amplitude —

Returns the amplitude of the detected single tone in volts peak (Vp).

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Express VIs\Express VI - Filter.vi

Components

Displays the measurements you configured this Express VI to perform and the
calculated values of those measurements. You can click any measurement listed in the
Measurement column, and the corresponding value or plot appears in the Result
Preview graph.

Searches for a specific frequency in the tone.

© National Instruments 1303


Functions

Center frequency to use in the frequency domain search for the single tone. The
default is 10. This option is available only when you place a checkmark in the Search
for Specific Frequency checkbox.

Calculates the phase of the detected single tone in degrees.

Calculates the frequency of the detected single tone in Hertz.

Calculates the amplitude of the detected single tone in volts peak (Vp).

Displays a preview of the measurement. The Result Preview plot indicates the value of
the selected measurement with a dotted line.

Displays the input signal.

Frequency width, as a percentage of the sampling rate, for the frequency domain
search for the single tone frequency. The default is 5. This option is available only
when you place a checkmark in the Search for Specific Frequency checkbox.

Timing and Transition Measurements


Performs timing and transition measurements, such as frequency, period, or duty
cycle, on a signal, usually a pulse.

Dialog Box Options

Option Description
Contains the following options:
Timing and
• Frequency—
Transition
Measurements
Calculates the frequency of Signals in Hertz.

1304 ni.com
Functions

Option Description

• Period—

Calculates the time in seconds between adjacent middle reference level


crossings in the same direction. The reciprocal of this value is the signal
frequency.

• Pulse duration—

Calculates the time difference in seconds between the first two middle
reference level crossings. Pulse duration also is known as pulse width.

• Duty cycle—

Calculates the Pulse duration as a fraction of the Period.

• Preshoot (%)—

Calculates the height of the local minimum that precedes a rising transition or
the local maximum that precedes a falling transition as a percentage of the
histogram-based amplitude of the signal.

• Overshoot (%)—

Calculates the height of the local maximum that follows a rising transition or
the local minimum that follows a falling transition as a percentage of the
histogram-based amplitude of the signal.

• Slew rate—

Calculates the ratio between (90% amplitude – 10% amplitude) and the rise
time.

Displays the measurement you configured this Express VI to perform and the
calculated value of that measurement. You can click any measurement listed in the
Results
Measurement column, and the corresponding value or plot appears in the Result
Preview graph.

© National Instruments 1305


Functions

Option Description

Displays the input signal.

Input Signal If you wire data to the Express VI and run it, Input Signal displays real data. If you
close and reopen the Express VI, Input Signal displays sample data until you run
the Express VI again.

Displays the measurement you configured this Express VI to perform and the
calculated value of that measurement. You can click any measurement listed in the
Measurement column, and the corresponding value or plot appears in the Result
Preview graph.
Result
Preview
If you wire data to the Express VI and run the VI, Result Preview displays real data.
If you close and reopen the Express VI, Result Preview displays sample data until
you run the VI again. If the cutoff frequency values are invalid, Result Preview does
not display valid data.

Inputs/Outputs
• Signals —

Contains the input signal or signals.

• error in (no error) —

Describes error conditions that occur before this node runs.

• error out —

Contains error information. This output provides standard error out functionality.

• Duration —

Returns the time difference in seconds between the first two middle reference level crossings.

• Preshoot —

Returns the height of the local minimum that precedes a rising transition or the local maximum
that precedes a falling transition as a percentage of the histogram-based amplitude of the signal.

1306 ni.com
Functions

• Slew Rate —

Returns the ratio between (90% amplitude – 10% amplitude) and the rise time.

• Frequency —

Returns the frequency of Signals in Hertz.

• Overshoot —

Returns the height of the local maximum that follows a rising transition or the local minimum
that follows a falling transition as a percentage of the histogram-based amplitude of the signal.

• Period —

Returns the time in seconds between adjacent middle reference level crossings in the same
direction. The reciprocal of this value is the signal frequency.

• Duty Cycle —

Calculates the Pulse duration as a fraction of the Period.

Components

Displays the measurement you configured this Express VI to perform and the
calculated value of that measurement. You can click any measurement listed in the
Measurement column, and the corresponding value or plot appears in the Result
Preview graph.

Calculates the ratio between (90% amplitude – 10% amplitude) and the rise time.

Calculates the height of the local minimum that precedes a rising transition or the
local maximum that precedes a falling transition as a percentage of the histogram-
based amplitude of the signal.

Calculates the time in seconds between adjacent middle reference level crossings in
the same direction. The reciprocal of this value is the signal frequency.

© National Instruments 1307


Functions

Calculates the height of the local maximum that follows a rising transition or the local
minimum that follows a falling transition as a percentage of the histogram-based
amplitude of the signal.

Calculates the Pulse duration as a fraction of the Period.

Calculates the time difference in seconds between the first two middle reference level
crossings. Pulse duration also is known as pulse width.

Calculates the frequency of Signals in Hertz.

Displays a preview of the measurement. The Result Preview plot indicates the value of
the selected measurement with a dotted line.

Displays the input signal.

Amplitude and Level Measurements


Performs voltage measurements on a signal.

Dialog Box Options

Option Description
Contains the following options:

• Mean (DC)—

Acquires a DC measurement of Signals.


Amplitude
Measurements • RMS—

Calculates the root mean square value of Signals.

• Apply window—

1308 ni.com
Functions

Option Description

Applies a low side lobe window to Signals. This option is available only when
you place a checkmark in the DC or RMS checkbox.

Use smoothing windows to taper the sharp transitions in the effective signal.
You do not typically use windows if you can acquire an integer number of
cycles of the signal or if you are analyzing noise spectra.

• Positive peak—

Measures the most positive peak in Signals.

• Negative peak—

Measures the most negative peak in Signals.

• Peak to peak—

Measures the most positive peak to the most negative peak in Signals.

• Cycle average—

Measures the mean level of one complete period of a periodic input signal.

• Cycle RMS—

Calculates the root mean square value of one complete period of a periodic
input signal.

Displays the measurements you configured this Express VI to perform and the
calculated values of those measurements. You can click any measurement listed in
Results
the Measurement column, and the corresponding value or plot appears in the
Result Preview graph.

Displays the input signal.

Input Signal If you wire data to the Express VI and run it, Input Signal displays real data. If you
close and reopen the Express VI, Input Signal displays sample data until you run
the Express VI again.

© National Instruments 1309


Functions

Option Description

Displays a preview of the measurement. The Result Preview plot indicates the
value of the selected measurement with a dotted line.
Result
If you wire data to the Express VI and run the VI, Result Preview displays real data.
Preview
If you close and reopen the Express VI, Result Preview displays sample data until
you run the VI again. If the cutoff frequency values are invalid, Result Preview does
not display valid data.

Inputs/Outputs
• Restart Averaging —

Specifies whether to restart the selected averaging process. The default is FALSE. When you call
this Express VI for the first time, the averaging process starts automatically.

This input appears only if you place a checkmark in the Averaging checkbox.

• error in (no error) —

Describes error conditions that occur before this node runs.

• Signals —

Contains the input signal or signals.

• Mean (DC) —

Returns the measured DC value of Signals.

• Negative Peak —

Returns a measurement of the most negative peak in Signals.

• Cycle Average —

Returns the mean level of one complete period of a periodic input signal.

The cycle average of a perfect sine wave is zero, but the average level of the entire signal can be
nonzero as a result of partial periods at the boundaries of the signal.

• Positive Peak —

1310 ni.com
Functions

Returns a measurement of the most positive peak in Signals.

• RMS —

Returns the calculated RMS of the values in Signals.

• Cycle RMS —

Returns the root mean square value of one complete period of a periodic input signal.

• Cycle Average —

Returns the mean level of one complete period of a periodic input signal. The cycle average of a
perfect sine wave is zero, but the average level of the entire signal can be nonzero as a result of
partial periods at the boundaries of the signal.

• Cycle RMS —

Returns the root mean square value of one complete period of a periodic input signal.

• Mean (DC) —

Returns the measured DC value of Signals.

• Negative Peak —

Returns a measurement of the most negative peak in Signals.

• Peak to Peak —

Returns a measurement from the most positive peak to the most negative peak in Signals.

• Positive Peak —

Returns a measurement of the most positive peak in Signals.

• RMS —

Returns the calculated RMS of the values in Signals.

• error out —

Contains error information. This output provides standard error out functionality.

• Peak to Peak —

© National Instruments 1311


Functions

Returns a measurement from the most positive peak to the most negative peak in Signals.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Express VIs\Express VI - Amplitude and


Level Measurements.vi

Components

Applies a low side lobe window to Signals. This option is available only when you
place a checkmark in the DC or RMS checkbox.

Displays the measurements you configured this Express VI to perform and the
calculated values of those measurements. You can click any measurement listed in the
Measurement column, and the corresponding value or plot appears in the Result
Preview graph.

Calculates the root mean square value of one complete period of a periodic input
signal.

Measures the mean level of one complete period of a periodic input signal.

Acquires a DC measurement of Signals.

Measures the most positive peak to the most negative peak in Signals.

Measures the most negative peak in Signals.

Measures the most positive peak in Signals.

Calculates the root mean square value of Signals.

Displays a preview of the measurement. The Result Preview plot indicates the value of
the selected measurement with a dotted line.

1312 ni.com
Functions

Displays the input signal.

Digital Waveform

Use the Digital Waveform VIs and functions to perform operations on digital
waveforms and digital data.

The VIs and functions on this palette can return waveform error codes.

Palette
Description
Object

Get Digital
Returns the digital waveform components you specify. You specify components by
Waveform
clicking on the center of the output terminal and selecting the component you want.
Components

Get Digital
Returns the digital data components you specify. You specify components by clicking
Data
on the center of the output terminal and selecting either transitions or data.
Components

Builds a digital waveform or modifies an existing waveform. If you do not wire the
Build Digital waveform input, the function creates a new waveform based on the components
Waveform you wire. If you wire the waveform input, the function modifies the waveform based
on the components you wire.

Builds digital data or modifies existing digital data. If you do not wire the digital data
Build Digital input, the function creates new digital data based on the components you wire. If
Data you wire the digital data input, the function modifies the digital data based on the
components you wire.

Set
Waveform Adds or replaces a waveform attribute. You can use any type of data for the value of
Attribute the attribute.
Function
Get Retrieves the names and values of all attributes or the value of a single attribute,

© National Instruments 1313


Functions

Palette
Description
Object
Waveform
Attribute depending on whether you wire the name parameter.
Function

Generates a pattern and returns the pattern as a digital waveform. Depending on the
Digital
instance you use, the VI can return a ramp, marching values, single value, random, or
Pattern
toggle pattern as a waveform. You must manually select the polymorphic instance
Generator
you want to use.

Returns the number of samples and signals contained in the digital input. Wire data
Digital Size to the digital waveform in input to determine the polymorphic instance to use or
manually select the instance.

Digital Returns a subset of the digital input so you can plot the extracted signals individually
Signal or in subgroups on a graph. Wire data to the digital waveform input to determine the
Subset polymorphic instance to use or manually select the instance.

Replaces a subset of the input digital waveform or digital data starting at the value
Replace
specified in start with new digital waveform data (DWDT) or digital data (DTbl). You
Subset
must manually select the polymorphic instance you want to use.

Uncompresses the digital signals in the digital input and returns the result in the
Uncompress
digital output. Wire data to the uncompressed digital waveform input to determine
Digital
the polymorphic instance to use or manually select the instance.

Compresses the digital signals in the digital input and returns the result in the digital
Compress
output. Wire data to the uncompressed digital waveform input to determine the
Digital
polymorphic instance to use or manually select the instance.

Digital Compares a digital waveform to another digital waveform or to a specified value or


Comparison compares a set of digital data to another set of digital data or to a specified value.

1314 ni.com
Functions

Palette
Description
Object

You must manually select the polymorphic instance you want to use.

Search for Searches for a digital pattern in the digital input. Wire data to the digital waveform
Digital in input to determine the polymorphic instance to use or manually select the
Pattern instance.

Appends the signals from digital waveform (low bits) to the LSB side of digital
Append waveform (high bits). If the sampling rates do not match, error out returns a
Digital warning. The start time of digital waveform (low bits) is ignored. Wire data to the
Signals digital waveform (high bits) input to determine the polymorphic instance to use or
manually select the instance.

Appends all samples from digital waveform B to the end of digital waveform A. If
Append
the sampling rates do not match, error out returns a warning. The start time of
Digital
digital waveform B is ignored. Wire data to the digital waveform A input to
Samples
determine the polymorphic instance to use or manually select the instance.

Inverts the digital data in the digital input so that a 0 becomes a 1 and vice versa or
Invert Digital an H becomes an L and vice versa. Wire data to the digital waveform input to
determine the polymorphic instance to use or manually select the instance.

Group
Groups digital data into a digital data array and groups digital waveforms into a
Digital
digital waveform array.
Signals

Digital Ring Use the digital ring constant to set the digital bit state of a digital waveform or digital
Constant data.

Empty
Returns an empty digital waveform. Use this constant to initialize shift registers or
Digital
build digital waveforms.
Waveform

© National Instruments 1315


Functions

Palette
Description
Object

Empty Returns empty digital data. Use this constant to initialize shift registers or build
Digital Data digital tables.

Digital
Use the Digital Conversion VIs and Functions to convert to and from digital data.
Conversion

Get Digital Waveform Components

Returns the digital waveform components you specify. You specify components by
clicking on the center of the output terminal and selecting the component you want.

Inputs/Outputs
• waveform —
waveform is the waveform from which you want to retrieve components.
• t0 —
t0 returns the trigger time of the waveform.
• dt —
dt returns the time interval in seconds between data points in the waveform.
• Y—
Y is the data values of a waveform.
• attributes —
attributes returns the names and values of all waveform attributes.

You also can use the Get Waveform Attribute VI to retrieve the names and values of all attributes
or the value of a single attribute.

Get Digital Data Components

Returns the digital data components you specify. You specify components by clicking
on the center of the output terminal and selecting either transitions or data.

1316 ni.com
Functions

Inputs/Outputs
• waveform —
digital data is the waveform from which you want to retrieve components.
• transitions —

• data —
digital data returns the data values where each row in the 2D array represents a single binary
value for one sample of data with the most significant bit of data in the first column and the least
significant bit of data in the last column.

Build Digital Waveform

Builds a digital waveform or modifies an existing waveform. If you do not wire the
waveform input, the function creates a new waveform based on the components you
wire. If you wire the waveform input, the function modifies the waveform based on the
components you wire.

Inputs/Outputs
• waveform —
waveform is the digital waveform you want to edit. If you do not wire an existing waveform, the
function creates a new waveform based on the components you wire.
• t0 —
t0 specifies the start time of the waveform.
• dt —
dt specifies the time interval in seconds between data points in the waveform.
• Y—
Y is a digital table that contains the data values of a waveform.
• attributes —
attributes sets the names and values of all waveform attributes.

You also can use the Set Waveform Attribute function to set the name and value of a single

© National Instruments 1317


Functions

attribute.

• output waveform —
output waveform is the resulting waveform. If you did not wire an existing waveform, this is a
new waveform. If you wired an existing waveform, this is the edited waveform.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Create Digital Waveform.vi

Build Digital Data

Builds digital data or modifies existing digital data. If you do not wire the digital data
input, the function creates new digital data based on the components you wire. If you
wire the digital data input, the function modifies the digital data based on the
components you wire.

You can use this function to build digital tables.

Inputs/Outputs
• waveform —
digital data is the digital data you want to edit. If you do not wire the digital data input, the
function creates new digital data based on the components you wire.
• transitions —

• data —
digital data component is a 2D array that contains the data values as 8-bit unsigned integers.
Each row in the 2D array represents a single binary value for one sample of data with the most
significant bit of data in the first column and the least significant bit of data in the last column.
Each value in the 2D array corresponds to a digital value, or digital data state, represented in the
digital data output.

1318 ni.com
Functions

The following table shows the digital data state represented by each of the valid 8-bit unsigned
integers.

Digital
Value Description
Data State
0 (Drive
0 Force logic low. Drive to the low voltage level (VOL).
Low)
1 (Drive
1 Force logic high. Drive to the high voltage level (VOH).
High)
Z (Force
2 Force logic high impedance. Turn the driver off.
Off)
L
Compare logic low (edge). Compare for a voltage level lower than the low
3 (Compare
voltage threshold.
Low)
H
Compare logic high (edge). Compare for a voltage level higher than the high
4 (Compare
voltage threshold (VOH).
High)
X
5 (Compare Compare logic unknown. Do not compare.
Unknown)
T
Compare logic high impedance (edge). Compare for a voltage level between
6 (Compare
the low voltage threshold (VOL) and the high voltage threshold (VOH).
Off)
V
Compare logic valid level (edge). Compare for a voltage level either lower than
7 (Compare
the low voltage threshold (VOL) or higher than the high voltage threshold (VOH).
Valid)

• output waveform —
digital data is the resulting digital data. If you did not wire existing digital data, this is the new
digital data. If you wired existing digital data, this is the edited digital data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Digital Waveform
Graph.lvproj

© National Instruments 1319


Functions

Set Waveform Attribute Function

Adds or replaces a waveform attribute. You can use any type of data for the value of
the attribute.

Inputs/Outputs
• waveform —

waveform is the waveform for which you want to add or replace an attribute.

• name —

name is the name of the attribute.

• value —

value is the value of the attribute. This input is polymorphic, so you can wire any data to it.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• waveform out —

waveform out is the waveform with the new or replaced attribute.

• replaced —

replaced indicates if an attribute was overwritten.

• error out —

error out contains error information. This output provides standard error out functionality.

If the attribute in name already exists, the function overwrites the attribute with the

1320 ni.com
Functions

new value, and replaced is TRUE. If the attribute in name does not exist already, the
function creates a new attribute. Some attributes are set by NI-DAQ and Express VIs.

The following table lists the waveform attributes set by NI-DAQ.

Data
Name Attribute Acceptable Values Description
Type
Hardware Any value is NI_DeviceNumber is the device
Device NI_DeviceNumber String acceptable for number of the hardware producing
Number NI_DeviceNumber. the waveform.
Any value is NI_ChannelName is the name of the
Name of
NI_ChannelName String acceptable for virtual channel producing the
Channel
NI_ChannelName. waveform.
NI_LineNames is the name of the
Name of Any value is digital line in the waveform. For more
Digital NI_LineNames String acceptable for than one digital line, the function
Line(s) NI_LineNames. returns the line names in reverse
order.
Volts, PSI, and so
forth are
Unit for NI_UnitDescription is the units of
NI_UnitDescription String acceptable values
Data measure for the waveform.
for
NI_UnitDescription.

The following table lists the waveform attributes set by Express VIs.

Data
Name Attribute Acceptable Values Description
Type
NI_ExpStartTimeStamp is
the time stamp of the first
sample in the first
waveform. In Express VIs,
Any value is acceptable
Start Time this is set once per start
NI_ExpStartTimeStamp for
Timestamp stamp of the VI and does not
NI_ExpStartTimeStamp.
change, even if waveform
data is generated in a
loop. In Express VIs,
NI_ExpStartTimeStamp is

© National Instruments 1321


Functions

set according to the PC


clock unless the
waveform originates in
NI-DAQ. When the
waveform originates in
NI-DAQ, NI-DAQ sets
NI_ExpStartTimeStamp.
NI_ExpTimeStamp is the
time stamp of the first
sample in the waveform.
In Express VIs,
NI_ExpTimeStamp is set
Time Any value is acceptable according to the PC clock
Timestamp NI_ExpTimeStamp
stamp for NI_ExpTimeStamp. unless the waveform
originates in NI-DAQ.
When the waveform
originates in NI-DAQ, NI-
DAQ sets
NI_ExpTimeStamp.
If the value of
Use a single character
NI_ExpXDimension is t, t0
for the
and dt are unchanged. If
NI_ExpXDimension
the value of
value. Currently, only t
X NI_ExpXDimension is f,
NI_ExpXDimension String for time and f for
Dimension Express VIs interpret t0
frequency are
and dt as f0 and df. For all
supported. The value
other values, or unknown
for NI_ExpXDimension
dimension, t0 and dt are
is case sensitive.
interpreted as X0 and dX.
If and only if
TRUE or FALSE are NI_ExpXDimension is t,
Relative
NI_ExpIsRelativeTime Boolean acceptable values for Express VIs set t0 as a
Time?
NI_ExpIsRelativeTime. relative/absolute time
stamp value.

Note Express VIs also use the attributes set by NI-DAQ. If the waveform does
not originate in NI-DAQ, Express VIs add NI_ChannelName.

1322 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Create.vi

Get Waveform Attribute Function

Retrieves the names and values of all attributes or the value of a single attribute,
depending on whether you wire the name parameter.

Attributes can be channel names. The connector pane displays the default data types
for this polymorphic function.

Inputs/Outputs
• waveform —

waveform is the waveform for which you want to retrieve an attribute(s) and value(s).

• name —

name is the name of the attribute whose value you want to retrieve.

Do not wire this parameter if you want to retrieve all the attributes associated with the specified
waveform. If you wire name, the names output changes to a Boolean output found, the array
output values changes to an output called value of the same type as default value, and the
function searches for only the specified attribute.
• default value (empty Variant) —

default value is a value and data type that you specify. If the function does not find the attribute
specified in name, it returns the default value.

If you wire default value, you must wire name.


• error in (no error) —

© National Instruments 1323


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• duplicate waveform —

duplicate waveform is the waveform data you input in waveform.

• names —

names returns a 1D array containing the names of all attributes associated with the waveform.

If you wire the name parameter, this output changes to a Boolean value found. found returns
TRUE if the function finds the attribute that you specify in name.
• values —

values returns a 1D array containing the values associated with each attribute of the specified
waveform in variant format.

You must unflatten each attribute value to an appropriate data type. If you wire name, this
output changes to a single variant value. If the function does not find the attribute that you
specify in name, it returns the value passed to default value.
• error out —

error out contains error information. This output provides standard error out functionality.

This function has two modes of behavior depending on whether you wire the name
parameter. By default, the function returns the names of all attributes and their
corresponding values in 1D arrays. If you wire name, the names output changes to a
Boolean output found, the values output changes to a variant output value, and the
function searches for only the specified attribute. If the function does not find the
specified attribute(s), or if it cannot convert the attribute(s) to the default value, found
is FALSE, and value displays the contents of default value.

The following table lists the waveform attributes set by NI-DAQ.

Data
Name Attribute Acceptable Values Description
Type
Hardware Any value is acceptable NI_DeviceNumber is the device
NI_DeviceNumber String
Device for NI_DeviceNumber. number of the hardware device

1324 ni.com
Functions

Data
Name Attribute Acceptable Values Description
Type
Number producing the waveform.
NI_ChannelName is the name of
Name of Any value is acceptable
NI_ChannelName String the virtual channel producing
Channel for NI_ChannelName.
the waveform.
Name of
Any value is acceptable NI_LineNames is the name of
Digital NI_LineNames String
for NI_LineNames. the digital line in the waveform.
Line(s)
Volts, PSI, and so forth
Unit for NI_UnitDescription is the units
NI_UnitDescription String are acceptable values for
Data of measure for the waveform.
NI_UnitDescription.

The following table lists the waveform attributes set by Express VIs.

Data
Name Attribute Acceptable Values Description
Type
NI_ExpStartTimeStamp is
the time stamp of the first
sample in the first
waveform. In Express VIs,
this is set once per start
of the VI and does not
change, even if waveform
Any value is acceptable data is generated in a
Start Time
NI_ExpStartTimeStamp for loop. In Express VIs,
Timestamp stamp
NI_ExpStartTimeStamp. NI_ExpStartTimeStamp is
set according to the PC
clock unless the
waveform originates in
NI-DAQ. When the
waveform originates in
NI-DAQ, NI-DAQ sets
NI_ExpStartTimeStamp.
NI_ExpTimeStamp is the
Time Any value is acceptable time stamp of the first
Timestamp NI_ExpTimeStamp
stamp for NI_ExpTimeStamp. sample in the waveform.
In Express VIs,

© National Instruments 1325


Functions

Data
Name Attribute Acceptable Values Description
Type
NI_ExpTimeStamp is set
according to the PC clock
unless the waveform
originates in NI-DAQ.
When the waveform
originates in NI-DAQ, NI-
DAQ sets
NI_ExpTimeStamp.
If the value of
NI_ExpXDimension is t, t0
Use a single character
and dt are unchanged. If
for the
the value of
NI_ExpXDimension
NI_ExpXDimension is f,
value. Currently, only t
X Express VIs interpret t0
NI_ExpXDimension String for time and f for
Dimension and dt as f0 and df. For all
frequency are
other values, Express VIs
supported. The value
generically interpret t0
for NI_ExpXDimension
and dt as X0 and dX, but
is case sensitive.
there is no effect
otherwise.
If and only if
TRUE or FALSE are NI_ExpXDimension is t,
Relative
NI_ExpIsRelativeTime Boolean acceptable values for Express VIs set t0 as a
Time?
NI_ExpIsRelativeTime. relative/absolute time
stamp value.

Note Express VIs also use the attributes set by NI-DAQ. If the waveform does
not originate in NI-DAQ, Express VIs add NI_ChannelName.

Digital Pattern Generator

Generates a pattern and returns the pattern as a digital waveform. Depending on the
instance you use, the VI can return a ramp, marching values, single value, random, or
toggle pattern as a waveform. You must manually select the polymorphic instance you
want to use.

1326 ni.com
Functions

• Digital Pattern Generator (Ramp) VI


• Digital Pattern Generator (Marching Values) VI
• Digital Pattern Generator (Single Value) VI
• Digital Pattern Generator (Random) VI
• Digital Pattern Generator (Toggle) VI

The Ramp instance generates a digital waveform that contains a binary count-up
pattern that starts at zero and counts up by one until it reaches 2n–1, where n =
number of signals.

Digital Pattern Generator (Ramp) VI


Generates a pattern and returns the pattern as a digital waveform. Depending on the
instance you use, the VI can return a ramp, marching values, single value, random, or
toggle pattern as a waveform. You must manually select the polymorphic instance you
want to use.

Inputs/Outputs
• number of samples —

number of samples specifies the number of samples to include in the generated digital
waveform.

• number of signals —

number of signals specifies the number of signals to include in the generated digital waveform.

• sample rate —

sample rate specifies the sample rate of the generated digital waveform. The default is 1 kHz.

© National Instruments 1327


Functions

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital waveform —

digital waveform returns the generated digital waveform pattern.

• error out —

error out contains error information. This output provides standard error out functionality.

The Ramp instance generates a digital waveform that contains a binary count-up
pattern that starts at zero and counts up by one until it reaches 2n–1, where n =
number of signals.

Digital Pattern Generator (Marching Values)


VI
Generates a pattern and returns the pattern as a digital waveform. Depending on the
instance you use, the VI can return a ramp, marching values, single value, random, or
toggle pattern as a waveform. You must manually select the polymorphic instance you
want to use.

Inputs/Outputs
• marching value —

marching value is the binary value that marches across the signals of the generated digital

1328 ni.com
Functions

waveform. The default is 1.

• hold value —

hold value is the binary value of the generated digital waveform. The default is 0.

• number of samples —

number of samples specifies the number of samples to include in the generated digital
waveform.

• number of signals —

number of signals specifies the number of signals to include in the generated digital waveform.

• sample rate —

sample rate specifies the sample rate of the generated digital waveform. The default is 1 kHz.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital waveform —

digital waveform returns the generated digital waveform pattern.

• error out —

error out contains error information. This output provides standard error out functionality.

The Ramp instance generates a digital waveform that contains a binary count-up
pattern that starts at zero and counts up by one until it reaches 2n–1, where n =
number of signals.

Digital Pattern Generator (Single Value) VI


Generates a pattern and returns the pattern as a digital waveform. Depending on the
instance you use, the VI can return a ramp, marching values, single value, random, or

© National Instruments 1329


Functions

toggle pattern as a waveform. You must manually select the polymorphic instance you
want to use.

Inputs/Outputs
• value —

value is the digital bit state of the generated digital waveform. The default is 0.

• number of samples —

number of samples specifies the number of samples to include in the generated digital
waveform.

• number of signals —

number of signals specifies the number of signals to include in the generated digital waveform.

• sample rate —

sample rate specifies the sample rate of the generated digital waveform. The default is 1 kHz.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital waveform —

digital waveform returns the generated digital waveform pattern.

• error out —

error out contains error information. This output provides standard error out functionality.

The Ramp instance generates a digital waveform that contains a binary count-up

1330 ni.com
Functions

pattern that starts at zero and counts up by one until it reaches 2n–1, where n =
number of signals.

Digital Pattern Generator (Random) VI


Generates a pattern and returns the pattern as a digital waveform. Depending on the
instance you use, the VI can return a ramp, marching values, single value, random, or
toggle pattern as a waveform. You must manually select the polymorphic instance you
want to use.

Inputs/Outputs
• number of samples —

number of samples specifies the number of samples to include in the generated digital
waveform.

• number of signals —

number of signals specifies the number of signals to include in the generated digital waveform.

• sample rate —

sample rate specifies the sample rate of the generated digital waveform. The default is 1 kHz.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital waveform —

digital waveform returns the generated digital waveform pattern.

• error out —

© National Instruments 1331


Functions

error out contains error information. This output provides standard error out functionality.

The Ramp instance generates a digital waveform that contains a binary count-up
pattern that starts at zero and counts up by one until it reaches 2n–1, where n =
number of signals.

Digital Pattern Generator (Toggle) VI


Generates a pattern and returns the pattern as a digital waveform. Depending on the
instance you use, the VI can return a ramp, marching values, single value, random, or
toggle pattern as a waveform. You must manually select the polymorphic instance you
want to use.

Inputs/Outputs
• value 2 —

value 2 is the second digital bit state of the generated digital waveform. The default is 1.

• value 1 —

value 1 is the first digital bit state of the generated digital waveform. The default is 0.

• number of samples —

number of samples specifies the number of samples to include in the generated digital
waveform.

• number of signals —

number of signals specifies the number of signals to include in the generated digital waveform.

1332 ni.com
Functions

• sample rate —

sample rate specifies the sample rate of the generated digital waveform. The default is 1 kHz.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital waveform —

digital waveform returns the generated digital waveform pattern.

• error out —

error out contains error information. This output provides standard error out functionality.

The Ramp instance generates a digital waveform that contains a binary count-up
pattern that starts at zero and counts up by one until it reaches 2n–1, where n =
number of signals.

Digital Size

Returns the number of samples and signals contained in the digital input. Wire data to
the digital waveform in input to determine the polymorphic instance to use or
manually select the instance.

• DWDT Digital Size VI


• DTbl Digital Size VI

DWDT Digital Size VI


Returns the number of samples and signals contained in the digital input. Wire data to
the digital waveform in input to determine the polymorphic instance to use or
manually select the instance.

© National Instruments 1333


Functions

Inputs/Outputs
• digital waveform in —

digital waveform in is the input digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital waveform out —

digital waveform out returns digital waveform in unchanged.

• number of samples —

number of samples returns the number of sample data elements of digital data contained in the
digital input.

• number of signals —

number of signals returns the number of signal elements contained in the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Digital Size VI


Returns the number of samples and signals contained in the digital input. Wire data to
the digital waveform in input to determine the polymorphic instance to use or
manually select the instance.

1334 ni.com
Functions

Inputs/Outputs
• digital data in —

digital data in is the input set of digital data.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital data out —

digital data out returns digital data in unchanged.

• number of samples —

number of samples returns the number of sample data elements of digital data contained in the
digital input.

• number of signals —

number of signals returns the number of signal elements contained in the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

Digital Signal Subset

Returns a subset of the digital input so you can plot the extracted signals individually
or in subgroups on a graph. Wire data to the digital waveform input to determine the
polymorphic instance to use or manually select the instance.

© National Instruments 1335


Functions

• DWDT Digital Signal Subset VI


• DTbl Digital Signal Subset VI

Use the Digital Signal Subset VI to extract individual signals from a digital waveform.
The block diagram below shows how you can combine extracted individual signals
with other digital data to create new digital waveforms.

The top Digital Signal Subset VI extracts the first and second signals from the digital
waveform. The bottom Digital Signal Subset VI extracts the fourth and fifth signals. The
Append Digital Samples VI appends the first signal to the fourth signal, appends the
second signal to the fifth signal, and plots the resulting two signals on a digital
waveform graph.

DWDT Digital Signal Subset VI


Returns a subset of the digital input so you can plot the extracted signals individually
or in subgroups on a graph. Wire data to the digital waveform input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• digital waveform —

1336 ni.com
Functions

digital waveform is the input digital waveform.

• signals —

signals is a 1D array of numbers. Each number in the array represents a signal number. If any
value in signals is greater than the number of signals in the digital input, the VI returns an error.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital subset —

digital subset returns the requested subset of digital waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Digital Signal Subset VI to extract individual signals from a digital waveform.
The block diagram below shows how you can combine extracted individual signals
with other digital data to create new digital waveforms.

The top Digital Signal Subset VI extracts the first and second signals from the digital
waveform. The bottom Digital Signal Subset VI extracts the fourth and fifth signals. The
Append Digital Samples VI appends the first signal to the fourth signal, appends the
second signal to the fifth signal, and plots the resulting two signals on a digital
waveform graph.

© National Instruments 1337


Functions

DTbl Digital Signal Subset VI


Returns a subset of the digital input so you can plot the extracted signals individually
or in subgroups on a graph. Wire data to the digital waveform input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• digital data —

digital data is the set of input digital data.

• signals —

signals is a 1D array of numbers. Each number in the array represents a signal number. If any
value in signals is greater than the number of signals in the digital input, the VI returns an error.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital subset —

digital subset returns the requested subset of digital data.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Digital Signal Subset VI to extract individual signals from a digital waveform.
The block diagram below shows how you can combine extracted individual signals
with other digital data to create new digital waveforms.

1338 ni.com
Functions

The top Digital Signal Subset VI extracts the first and second signals from the digital
waveform. The bottom Digital Signal Subset VI extracts the fourth and fifth signals. The
Append Digital Samples VI appends the first signal to the fourth signal, appends the
second signal to the fifth signal, and plots the resulting two signals on a digital
waveform graph.

Replace Subset

Replaces a subset of the input digital waveform or digital data starting at the value
specified in start with new digital waveform data (DWDT) or digital data (DTbl). You
must manually select the polymorphic instance you want to use.

• DWDT Replace Subset VI


• DTbl Replace Subset VI

DWDT Replace Subset VI


Replaces a subset of the input digital waveform or digital data starting at the value
specified in start with new digital waveform data (DWDT) or digital data (DTbl). You
must manually select the polymorphic instance you want to use.

© National Instruments 1339


Functions

Inputs/Outputs
• start value format —

start value format specifies the search method.

Samples (default)—The subset begins from a particular element from the set of waveform data
0
in digital waveform in.
1 Relative Time—The subset begins from the data value at a particular time.

• digital waveform in —

digital waveform in is the digital waveform for which you want to replace a subset.

• new digital waveform —

new digital waveform is the new digital waveform data with which you want to replace a subset
of digital waveform in.

• start samples/time —

start samples/time is the data element or time value where the subset you are replacing begins.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• signal index —

signal index specifies the signal at which to begin replacing data. The default is 0.

• digital waveform out —

digital waveform out returns digital waveform in with the replaced subset.

• actual start samples/time —

actual start samples/time is the actual data element where you replaced the subset.

• error out —

error out contains error information. This output provides standard error out functionality.

1340 ni.com
Functions

DTbl Replace Subset VI


Replaces a subset of the input digital waveform or digital data starting at the value
specified in start with new digital waveform data (DWDT) or digital data (DTbl). You
must manually select the polymorphic instance you want to use.

Inputs/Outputs
• digital data in —

digital data in is the digital data for which you want to replace a subset.

• new digital data —

new digital data is the new digital data with which you want to replace a subset of digital data
in.

• start —

start is the data element where you want to start replacing the digital table subset. The default is
0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• signal index —

signal index specifies the signal at which to begin replacing data. The default is 0.

• digital data out —

digital data out returns digital data in with the replaced subset.

• error out —

© National Instruments 1341


Functions

error out contains error information. This output provides standard error out functionality.

Uncompress Digital

Uncompresses the digital signals in the digital input and returns the result in the
digital output. Wire data to the uncompressed digital waveform input to determine
the polymorphic instance to use or manually select the instance.

• DWDT Uncompress Digital VI


• DTbl Uncompress Digital VI

DWDT Uncompress Digital VI


Uncompresses the digital signals in the digital input and returns the result in the
digital output. Wire data to the uncompressed digital waveform input to determine
the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• compressed digital waveform —

compressed digital waveform is the waveform you want to uncompress.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

1342 ni.com
Functions

• uncompressed digital waveform —

uncompressed digital waveform returns the uncompressed digital waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Uncompress Digital VI


Uncompresses the digital signals in the digital input and returns the result in the
digital output. Wire data to the uncompressed digital waveform input to determine
the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• digital data in —

digital data in is the input set of digital data.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital data out —

digital data out returns the uncompressed digital data.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 1343


Functions

Compress Digital

Compresses the digital signals in the digital input and returns the result in the digital
output. Wire data to the uncompressed digital waveform input to determine the
polymorphic instance to use or manually select the instance.

• DWDT Compress Digital VI


• DTbl Compress Digital VI

Use the Compress Digital VI to compress digital data when you want to display two or
more serial digital signals with the same bit sets on the same row to better visualize
the data. For example, if you acquire 10 digital waveform samples and nine waveforms
are identical but the tenth waveform differs, compressing the digital data helps you
easily find which waveform is different. Compressing digital data also conserves
memory resources. Use the Uncompress Digital VI to uncompress digital data you
compress.

DWDT Compress Digital VI


Compresses the digital signals in the digital input and returns the result in the digital
output. Wire data to the uncompressed digital waveform input to determine the
polymorphic instance to use or manually select the instance.

Inputs/Outputs
• force compression? —

force compression? specifies whether the compression is performed even if the data already
appears to be compressed.

1344 ni.com
Functions

• uncompressed digital waveform —

uncompressed digital waveform is the waveform you want to compress.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• compressed digital waveform —

compressed digital waveform returns the compressed waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Compress Digital VI to compress digital data when you want to display two or
more serial digital signals with the same bit sets on the same row to better visualize
the data. For example, if you acquire 10 digital waveform samples and nine waveforms
are identical but the tenth waveform differs, compressing the digital data helps you
easily find which waveform is different. Compressing digital data also conserves
memory resources. Use the Uncompress Digital VI to uncompress digital data you
compress.

DTbl Compress Digital VI


Compresses the digital signals in the digital input and returns the result in the digital
output. Wire data to the uncompressed digital waveform input to determine the
polymorphic instance to use or manually select the instance.

© National Instruments 1345


Functions

Inputs/Outputs
• force compression? —

force compression? specifies whether the compression is performed even if the data already
appears to be compressed.

• uncompressed digital data —

uncompressed digital data is the digital data you want to compress.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• compressed digital data —

compressed digital data returns the compressed digital data.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Compress Digital VI to compress digital data when you want to display two or
more serial digital signals with the same bit sets on the same row to better visualize
the data. For example, if you acquire 10 digital waveform samples and nine waveforms
are identical but the tenth waveform differs, compressing the digital data helps you
easily find which waveform is different. Compressing digital data also conserves
memory resources. Use the Uncompress Digital VI to uncompress digital data you
compress.

Digital Comparison

Compares a digital waveform to another digital waveform or to a specified value or


compares a set of digital data to another set of digital data or to a specified value. You
must manually select the polymorphic instance you want to use.

1346 ni.com
Functions

• DWDT Digital To Digital Comparison VI


• DTbl Digital To Digital Comparison VI
• DWDT Digital Comparison VI
• DTbl Digital Comparison VI

DWDT Digital To Digital Comparison VI


Compares a digital waveform to another digital waveform or to a specified value or
compares a set of digital data to another set of digital data or to a specified value. You
must manually select the polymorphic instance you want to use.

Inputs/Outputs
• start sample B —

start sample B specifies where to start the comparison within digital waveform B.

• start sample A —

start sample A specifies where to start the comparison within digital waveform A.

• digital waveform A —

digital waveform A is the waveform for which you want to perform a digital comparison.

• digital waveform B —

digital waveform B is the waveform for which you want to perform a digital comparison.

• error in (no error) —

© National Instruments 1347


Functions

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• compare level —

compare level specifies the comparison results returned by the VI.

Pass/Fail Only (default)—Specifies that the VI returns only passed? as an output, which
0
improves the performance of the comparison.
1 Pass/Fail and # Errors—Specifies that the VI returns passed? and # failed samples.
Pass/Fail, # Errors and Diff Data—Specifies that the VI returns passed?, # failed samples, and
2
diff data.

• # samples to compare (-1: all) —

# samples to compare specifies the number of samples in digital waveform A and digital
waveform B to compare. The default value is –1, which specifies that the VI compares all
samples.

• passed? —

passed? returns TRUE if all corresponding values in digital waveform A and digital waveform B
match.

• # failed samples —

# failed samples returns the total number of corresponding samples in digital waveform A and
digital waveform B that do not match.

• diff data —

diff data returns the waveform representing the comparison of digital waveform A and digital
waveform B. Zeros represent corresponding samples that match. Ones represent corresponding
samples that differ. You can use this data to determine the exact location of all differing samples.

• error out —

error out contains error information. This output provides standard error out functionality.

1348 ni.com
Functions

DTbl Digital To Digital Comparison VI


Compares a digital waveform to another digital waveform or to a specified value or
compares a set of digital data to another set of digital data or to a specified value. You
must manually select the polymorphic instance you want to use.

Inputs/Outputs
• start position B —

start position B specifies where to start the comparison within digital data B.

• start position A —

start position A specifies where to start the comparison within digital data A.

• digital data A —

digital data A is the digital data for which you want to perform a digital comparison.

• digital data B —

digital data B is the digital data for which you want to perform a digital comparison.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• compare level —

compare level specifies the comparison results returned by the VI.

© National Instruments 1349


Functions

Pass/Fail Only (default)—Specifies that the VI returns only passed? as an output, which
0
improves the performance of the comparison.
1 Pass/Fail and # Errors—Specifies that the VI returns passed? and # failed samples.
Pass/Fail, # Errors and Diff Data—Specifies that the VI returns passed?, # failed samples, and
2
diff data.

• # samples to compare (-1:all) —

# samples to compare specifies the number of samples in digital data A and digital data B to
compare. The default value is -1, which specifies that the VI compares all samples.

• passed? —

passed? returns TRUE if all corresponding values in digital data A and digital data B match.

• # failed samples —

# failed samples returns the total number of corresponding samples in digital data A and digital
data B that do not match.

• diff data —

diff data returns the digital data representing the comparison of digital data A and digital data
B. Zeros represent corresponding samples that match. Ones represent corresponding samples
that differ. You can use this data to determine the exact location of all differing samples.

• error out —

error out contains error information. This output provides standard error out functionality.

DWDT Digital Comparison VI


Compares a digital waveform to another digital waveform or to a specified value or
compares a set of digital data to another set of digital data or to a specified value. You
must manually select the polymorphic instance you want to use.

1350 ni.com
Functions

Inputs/Outputs
• digital waveform —

digital waveform is the input digital waveform.

• comparison —

comparison specifies to what value the digital data contained in the digital input is compared.

0 Equal 0 (default)—Force Down


1 Equal 1—Force Up
2 Equal Z—Force Z
3 Equal L—Compare Low
4 Equal H—Compare High
5 Equal X—Compare Don't Care
6 Equal T—Compare Invalid
7 Equal V—Compare Valid
8 Equal 0 or L
9 Equal 1 or H
10 Not Equal 0 or 1
11 Not Equal 0, 1, L, or H

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• boolean array —

boolean array is a Boolean-array representation of where the comparison value is found in the
digital data contained in the digital input.

• passed? —

passed? returns TRUE if any value in the digital data contained in the digital input matches the
comparison request specified in comparison.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 1351


Functions

DTbl Digital Comparison VI


Compares a digital waveform to another digital waveform or to a specified value or
compares a set of digital data to another set of digital data or to a specified value. You
must manually select the polymorphic instance you want to use.

Inputs/Outputs
• digital data —

digital data is the set of input digital data.

• comparison —

comparison specifies to what value the digital data contained in the digital input is compared.

0 Equal 0 (default)—Force Down


1 Equal 1—Force Up
2 Equal Z—Force Z
3 Equal L—Compare Low
4 Equal H—Compare High
5 Equal X—Compare Don't Care
6 Equal T—Compare Invalid
7 Equal V—Compare Valid
8 Equal 0 or L
9 Equal 1 or H
10 Not Equal 0 or 1
11 Not Equal 0, 1, L, or H

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

1352 ni.com
Functions

• boolean array —

boolean array is a Boolean-array representation of where the comparison value is found in the
digital data contained in the digital input.

• Passed? —

Passed? returns TRUE if any value in the digital data contained in the digital input matches the
comparison request specified in comparison.

• error out —

error out contains error information. This output provides standard error out functionality.

Search for Digital Pattern

Searches for a digital pattern in the digital input. Wire data to the digital waveform in
input to determine the polymorphic instance to use or manually select the instance.

• DWDT Search for Digital Pattern VI


• DTbl Search for Digital Pattern VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Search Digital Data for
Pattern.vi

DWDT Search for Digital Pattern VI


Searches for a digital pattern in the digital input. Wire data to the digital waveform in
input to determine the polymorphic instance to use or manually select the instance.

© National Instruments 1353


Functions

Inputs/Outputs
• start value format —

start value format specifies the search method.

Samples (default)—The subset begins from a particular element from the set of waveform data
0
in digital waveform in.
1 Relative Time—The subset begins from the data value at a particular time.

• digital waveform in —

digital waveform in is the input digital waveform.

• digital pattern —

digital pattern specifies the digital pattern for which you want to search.

For example, if you acquire a large digital waveform and want to see if any part of the digital
waveform matches a certain pattern, wire that pattern to the digital pattern input to discover
any matches.

• start index/time —

start index/time specifies the point in digital waveform in where the search begins. You specify
whether this is an index or time in indexing mode. The default is 0, which is the beginning of
digital waveform in.

When indexing mode is set to Relative Time, this VI checks start index/time to determine if it is
an integer multiple of dt. If start index/time is not an integer multiple of dt, this VI uses the
closest exact multiple of dt. This VI returns an error if start index/time is out of range for digital
waveform in.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following

1354 ni.com
Functions

exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• compare mode —

compare mode specifies how to handle values of X for the search.

Compare X States (default)—Values of X in digital pattern match only to X states in the input
0
data.
1 Ignore X States—Values of X in digital pattern are wildcards and match to any digital state.

• digital waveform out —

digital waveform out returns digital waveform in unchanged.

• index/time of pattern —

index/time of pattern is the first index or time value in digital waveform in following start
index/time that matches the location of digital pattern.

If indexing mode is set to Relative Time, index/time of pattern represents the time. If indexing
mode is set to Samples, index/time of pattern represents the index.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Search Digital Data for
Pattern.vi

DTbl Search for Digital Pattern VI


Searches for a digital pattern in the digital input. Wire data to the digital waveform in

© National Instruments 1355


Functions

input to determine the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• digital data in —

digital data in is the input set of digital data.

• digital pattern —

digital pattern specifies the digital pattern for which you want to search.

For example, if you acquire a large digital waveform and want to see if any part of the digital
waveform matches a certain pattern, wire that pattern to the digital pattern input to discover
any matches.

• start index —

start index specifies the point in digital data in where the search begins. The default is 0, which
is the beginning of digital data in. The VI returns an error if start index is out of range for digital
data in.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• compare mode —

compare mode specifies how to handle values of X for the search.

Compare X States (default)—Values of X in digital pattern match only to X states in the input
0
data.
1 Ignore X States—Values of X in digital pattern are wildcards and match to any digital state.

1356 ni.com
Functions

• digital data out —

digital data out returns digital data in unchanged.

• index of pattern —

index of pattern returns the first index in digital data in following start index that matches the
location of digital pattern.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Search Digital Data for
Pattern.vi

Append Digital Signals

Appends the signals from digital waveform (low bits) to the LSB side of digital
waveform (high bits). If the sampling rates do not match, error out returns a warning.
The start time of digital waveform (low bits) is ignored. Wire data to the digital
waveform (high bits) input to determine the polymorphic instance to use or manually
select the instance.

• DWDT Append Digital Signals VI


• DTbl Append Digital Signals VI

Use the Append Digital Signals VI to append the signals from two separate digital
waveforms into a single digital waveform. You can append signals with the same
number of samples or of different numbers of samples. For example, if you have two
digital signals that both consist of two rows of 8 bits, the resulting digital data consists

© National Instruments 1357


Functions

of two rows of 16 bits. If you combine two signals, one that consists of two rows of 8
bits and the other that consists of one row of 8 bits, the resulting digital data consists
of two rows of 16 bits. The Append Digital Signals VI pads the remaining columns in the
second sample with the value you select in the default value input.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Append Digital Data By
Signal.vi

DWDT Append Digital Signals VI


Appends the signals from digital waveform (low bits) to the LSB side of digital
waveform (high bits). If the sampling rates do not match, error out returns a warning.
The start time of digital waveform (low bits) is ignored. Wire data to the digital
waveform (high bits) input to determine the polymorphic instance to use or manually
select the instance.

Inputs/Outputs
• default value —

default value specifies the value to use to fill in the extra samples of the digital data in digital
waveform out if digital waveform (low bits) and digital waveform (high bits) do not have the
same number of samples.

0 0 (default)—Force Down
1 1—Force Up
2 Z—Force Z

1358 ni.com
Functions

3 L—Compare Low
4 H—Compare High
5 X—Compare Don't Care
6 T—Compare Invalid
7 V—Compare Valid

• digital waveform (high bits) —

digital waveform (high bits) is the first set of data in the digital waveform.

• digital waveform (low bits) —

digital waveform (low bits) is the set of data to append to digital waveform (high bits).

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital waveform out —

digital waveform out returns the waveform that results from appending digital waveform (low
bits) to digital waveform (high bits). This output matches the compression of the input.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Append Digital Signals VI to append the signals from two separate digital
waveforms into a single digital waveform. You can append signals with the same
number of samples or of different numbers of samples. For example, if you have two
digital signals that both consist of two rows of 8 bits, the resulting digital data consists
of two rows of 16 bits. If you combine two signals, one that consists of two rows of 8
bits and the other that consists of one row of 8 bits, the resulting digital data consists
of two rows of 16 bits. The Append Digital Signals VI pads the remaining columns in the
second sample with the value you select in the default value input.

© National Instruments 1359


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Append Digital Data By
Signal.vi

DTbl Append Digital Signals VI


Appends the signals from digital waveform (low bits) to the LSB side of digital
waveform (high bits). If the sampling rates do not match, error out returns a warning.
The start time of digital waveform (low bits) is ignored. Wire data to the digital
waveform (high bits) input to determine the polymorphic instance to use or manually
select the instance.

Note Appends signals of digital data B to the LSB side of digital data A. If the
number of samples do not match, error out returns a warning. The number
of signals do not have to be the same.

Inputs/Outputs
• default value —

default value specifies the value to use to fill in the extra samples of the digital data in digital
waveform out if digital waveform (low bits) and digital waveform (high bits) do not have the
same number of samples.

0 0 (default)—Force Down
1 1—Force Up
2 Z—Force Z

1360 ni.com
Functions

3 L—Compare Low
4 H—Compare High
5 X—Compare Don't Care
6 T—Compare Invalid
7 V—Compare Valid

• digital data (high bits) —

digital data (high bits) is the first set of data.

• digital data (low bits) —

digital data (low bits) is the set of data to append to digital data (high bits).

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital data out —

digital data out returns the digital data that results from appending digital data (low bits) to
digital data (high bits).

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Append Digital Signals VI to append the signals from two separate digital
waveforms into a single digital waveform. You can append signals with the same
number of samples or of different numbers of samples. For example, if you have two
digital signals that both consist of two rows of 8 bits, the resulting digital data consists
of two rows of 16 bits. If you combine two signals, one that consists of two rows of 8
bits and the other that consists of one row of 8 bits, the resulting digital data consists
of two rows of 16 bits. The Append Digital Signals VI pads the remaining columns in the
second sample with the value you select in the default value input.

© National Instruments 1361


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Append Digital Data By
Signal.vi

Append Digital Samples

Appends all samples from digital waveform B to the end of digital waveform A. If the
sampling rates do not match, error out returns a warning. The start time of digital
waveform B is ignored. Wire data to the digital waveform A input to determine the
polymorphic instance to use or manually select the instance.

• DWDT Append Digital Samples VI


• DTbl Append Digital Samples VI

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Append Digital Data By
Sample.vi

DWDT Append Digital Samples VI


Appends all samples from digital waveform B to the end of digital waveform A. If the
sampling rates do not match, error out returns a warning. The start time of digital
waveform B is ignored. Wire data to the digital waveform A input to determine the
polymorphic instance to use or manually select the instance.

1362 ni.com
Functions

Inputs/Outputs
• default value —

default value specifies the value to use to fill in the extra signals of the digital data in digital
waveform out if digital waveform A and digital waveform B do not have the same number of
signals.

0 0 (default)—Force Down
1 1—Force Up
2 Z—Force Z
3 L—Compare Low
4 H—Compare High
5 X—Compare Don't Care
6 T—Compare Invalid
7 V—Compare Valid

• digital waveform A —

digital waveform A is the first set of data in the digital waveform.

• digital waveform B —

digital waveform B is the set of data to append to digital waveform A.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital waveform out —

digital waveform out returns the waveform that results from appending digital waveform (low
bits) to digital waveform (high bits). This output matches the compression of the input.

• error out —

© National Instruments 1363


Functions

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Append Digital Data By
Sample.vi

DTbl Append Digital Samples VI


Appends all samples from digital waveform B to the end of digital waveform A. If the
sampling rates do not match, error out returns a warning. The start time of digital
waveform B is ignored. Wire data to the digital waveform A input to determine the
polymorphic instance to use or manually select the instance.

Note

Appends all samples from digital data B to the end of digital data A. If the
number of signals do not match, error out returns a warning. The number of
samples do not have to be the same.

Inputs/Outputs
• default value —

default value specifies the value to fill in the extra signals of digital data out if digital data A and
digital data B do not have the same number of signals.

1364 ni.com
Functions

0 0 (default)—Force Down
1 1—Force Up
2 Z—Force Z
3 L—Compare Low
4 H—Compare High
5 X—Compare Don't Care
6 T—Compare Invalid
7 V—Compare Valid

• digital data A —

digital data A is the first set of data.

• digital data B —

digital data B is the set of data to append to digital data A.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital data out —

digital data out returns the digital data that results from appending digital data (low bits) to
digital data (high bits).

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Append Digital Data By
Sample.vi

© National Instruments 1365


Functions

Invert Digital

Inverts the digital data in the digital input so that a 0 becomes a 1 and vice versa or an
H becomes an L and vice versa. Wire data to the digital waveform input to determine
the polymorphic instance to use or manually select the instance.

• DWDT Invert Digital VI


• DTbl Invert Digital VI

DWDT Invert Digital VI


Inverts the digital data in the digital input so that a 0 becomes a 1 and vice versa or an
H becomes an L and vice versa. Wire data to the digital waveform input to determine
the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• digital waveform —

digital waveform is the input digital waveform.

• response to invert error —

response to invert error specifies what to do if any value in the digital input is not a 0, 1, H, or L.

Warn but Convert (default)—Any values that are not 0, 1, H, or L are left unchanged and a
0
warning is returned in error out.
1 Fail—The VI returns an empty inverted digital output and returns an error in error out.

• error in (no error) —

1366 ni.com
Functions

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• signal index (0) —

signal index specifies the signal at which to begin inverting data. The default is 0, which inverts
all signals.

• number of signals (-1:all) —

number of signals specifies the number of signals to invert, beginning with the signal at signal
index.

• inverted waveform —

inverted waveform contains the inverted waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Invert Digital VI


Inverts the digital data in the digital input so that a 0 becomes a 1 and vice versa or an
H becomes an L and vice versa. Wire data to the digital waveform input to determine
the polymorphic instance to use or manually select the instance.

Inputs/Outputs
• digital data —

© National Instruments 1367


Functions

digital data is the set of input digital data.

• response to invert error —

response to invert error specifies what to do if any value in the digital input is not a 0, 1, H, or L.

Warn but Convert (default)—Any values that are not 0, 1, H, or L are left unchanged and a
0
warning is returned in error out.
1 Fail—The VI returns an empty inverted digital output and returns an error in error out.

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• signal index (0) —

signal index specifies the signal at which to begin inverting data. The default is 0, which inverts
all signals.

• number of signals (-1:all) —

number of signals specifies the number of signals to invert, beginning with the signal at signal
index.

• inverted digital data —

inverted digital data contains the inverted digital data.

• error out —

error out contains error information. This output provides standard error out functionality.

Group Digital Signals

Groups digital data into a digital data array and groups digital waveforms into a digital
waveform array.

LabVIEW treats ungrouped signals as individual groups.

1368 ni.com
Functions

Dialog Box Options

Option Description

Specifies the number of signals you want to wire to the Express VI. Configure this option
first.
Number
of signals
This number must match the number of signals you wire to Digital Data In. Otherwise,
LabVIEW returns an error.

Use
Allows you to retain the original names of the waveforms you wire to Digital Data In.
incoming
This checkbox contains a checkmark by default. Remove the checkmark from this
waveform
checkbox to use the line and bus names you specify using the Rename button.
names

Order of
Displays the sequential order of the digital signals.
signals

Contains the lines and buses you configure in the configuration dialog box.

Plot Use this tree control to drag and drop lines into the order you want to view them in the
Legend output array. To put lines into groups, right-click a line and select Insert Bus and then
drag other lines onto that bus. You cannot drag a line onto another line, a bus onto
another bus, or a bus onto a line.

Graph Displays a preview of the lines and buses based on the organization you specify in the
Preview configuration dialog box.

Rename Allows you to rename the line or bus you select in the Plot Legend tree control. You also

© National Instruments 1369


Functions

Option Description

can right-click a line or bus and select Rename from the shortcut menu or double-click
a line or bus to type a new name.

To rename lines or buses, you must remove the checkmark from the Use incoming
waveform names checkbox. Otherwise, the incoming line names take precedence over
the new names you specify.

Inserts a new bus above the line or bus you select in the Plot Legend tree control. You
Insert Bus
also can right-click a line or bus and select Insert Bus from the shortcut menu.

Deletes all the buses from the Plot Legend tree control.
Delete All
To delete a single bus, right-click the bus and select Delete Bus from the shortcut
Buses
menu. You can delete only buses, not lines. LabVIEW considers lines listed under
deleted buses as ungrouped signals.

Inputs/Outputs
• error in (no error) —
Describes error conditions that occur before this node runs.
• Digital Data In —
Specifies the input signals you want to organize into groups.
• error out —
Contains error information. This output provides standard error out functionality.
• Digital Data Out —
Returns a digital data array or a digital waveform array, depending on the data type of Digital
Data In.

Digital Ring Constant

Use the digital ring constant to set the digital bit state of a digital waveform or digital
data.

You select, add or remove, and rearrange values in ring constants much the same way
you do for ring and enumerated controls.

1370 ni.com
Functions

The digital ring constant includes a predefined list of the eight digital states supported
by the digital waveform and digital data type:

Digital
Description
Data State
0 (Force
Force logic low. Drive to the low voltage level (VIL).
Down)
1 (Force
Force logic high. Drive to the high voltage level (VIH).
Up)
Z (Force
Force logic high impedance. Turn the driver off.
Off)
L (Compare Compare logic low (edge). Compare for a voltage level lower than the low voltage
Low) threshold (VOL).
H
Compare logic high (edge). Compare for a voltage level higher than the high voltage
(Compare
threshold (VOH).
High)
X (Compare
Compare logic unknown. Do not compare.
Unknown)
T
Compare logic high impedance (edge). Compare for a voltage level between the low
(Compare
voltage threshold (VOL) and the high voltage threshold (VOH).
Off)
V (Compare Compare logic valid level (edge). Compare for a voltage level either lower than the low
Valid) voltage threshold (VOL) or higher than the high voltage threshold (VOH).

You can change the representation of a ring constant to any digital state you want to
use.

Empty Digital Waveform

Returns an empty digital waveform. Use this constant to initialize shift registers or
build digital waveforms.

© National Instruments 1371


Functions

Inputs/Outputs
• digital waveform out —

digital waveform out returns an empty digital waveform.

Empty Digital Data

Returns empty digital data. Use this constant to initialize shift registers or build digital
tables.

Inputs/Outputs
• digital data —

digital data returns empty digital data.

Digital Conversion

Use the Digital Conversion VIs and Functions to convert to and from digital data.

The VIs on this palette can return waveform error codes.

1372 ni.com
Functions

Palette
Description
Object

Boolean
Converts a 2D Boolean array to a digital waveform or digital data. You must manually
Array to
select the polymorphic instance you want to use.
Digital

Binary to Converts a binary array of unsigned integers to a digital waveform or set of digital
Digital data. You must manually select the polymorphic instance you want to use.

Spreadsheet
Converts a spreadsheet string to a digital waveform or set of digital data. You must
String to
manually select the polymorphic instance you want to use.
Digital

Digital to Converts the digital waveform or digital data in the digital input to a 2D Boolean
Boolean array. Wire data to the digital waveform input to determine the polymorphic
Array instance to use or manually select the instance.

Digital to Converts a digital waveform or set of digital data to a binary array of unsigned
Binary integers. You must manually select the polymorphic instance you want to use.

Boolean Array to Digital


Converts a 2D Boolean array to a digital waveform or digital data. You must manually
select the polymorphic instance you want to use.

• DWDT Boolean Array to Digital VI


• DTbl Boolean Array to Digital VI

© National Instruments 1373


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Search Digital Data for
Pattern.vi

DWDT Boolean Array to Digital VI


Converts a 2D Boolean array to a digital waveform or digital data. You must manually
select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (F) —

compress data specifies whether to compress the digital output. The default is FALSE.

• boolean array —

boolean array is the 2D Boolean array you want to convert to digital waveform.

• sample rate —

sample rate specifies the frequency in samples per second of the output digital waveform.

• mode —

mode specifies whether the conversion is performed on the data with the least significant bit
(LSB) first or most significant bit (MSB) first. The order of the digital data in digital waveform
reflects the selection made in mode.

1374 ni.com
Functions

LSB First
0
(default)
1 MSB First

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital waveform —

digital waveform returns the waveform resulting from the conversion of boolean array.

The order of the digital data in digital waveform reflects the bit direction selected in mode.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and


Charts\Digital Waveform Graph\Search Digital Data for
Pattern.vi

DTbl Boolean Array to Digital VI


Converts a 2D Boolean array to a digital waveform or digital data. You must manually
select the polymorphic instance you want to use.

© National Instruments 1375


Functions

Inputs/Outputs
• compress data (F) —

compress data specifies whether to compress the digital output. The default is FALSE.

• boolean array —

boolean array is the 2D Boolean array you want to convert to digital data.

• mode —

mode specifies whether the conversion is performed on the data with least significant bit (LSB)
first or most significant bit (MSB) first. The order of the digital data in digital data reflects the
selection made in mode.

LSB First
0
(default)
1 MSB First

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• digital data —

digital data returns the digital data resulting from the conversion of boolean array.

The order of the digital data reflects the bit direction selected in mode.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Controls and Indicators\Graphs and

1376 ni.com
Functions

Charts\Digital Waveform Graph\Search Digital Data for


Pattern.vi

Binary to Digital
Converts a binary array of unsigned integers to a digital waveform or set of digital data.
You must manually select the polymorphic instance you want to use.

• DWDT Binary U32 to Digital VI


• DTbl Binary U32 to Digital VI
• DWDT Binary U16 to Digital VI
• DTbl Binary U16 to Digital VI
• DWDT Binary U8 to Digital VI
• DTbl Binary U8 to Digital VI

DWDT Binary U32 to Digital VI


Converts a binary array of unsigned integers to a digital waveform or set of digital data.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• binary array —

binary array is the 1D array of unsigned 32-bit integers you want to convert to a digital

© National Instruments 1377


Functions

waveform or set of digital data.

• sample rate —

sample rate specifies the frequency in samples per second of the output digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital waveform —

digital waveform returns the converted digital waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Binary U32 to Digital VI


Converts a binary array of unsigned integers to a digital waveform or set of digital data.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• binary array —

binary array is the 1D array of unsigned 32-bit integers you want to convert to a digital
waveform or set of digital data.

• error in (no error) —

1378 ni.com
Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital data —

digital data returns the converted set of digital data.

• error out —

error out contains error information. This output provides standard error out functionality.

DWDT Binary U16 to Digital VI


Converts a binary array of unsigned integers to a digital waveform or set of digital data.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• binary array —

binary array is the 1D array of unsigned 16-bit integers you want to convert to a digital
waveform or set of digital data.

• sample rate —

sample rate specifies the frequency in samples per second of the output digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides

© National Instruments 1379


Functions

standard error in functionality.

• digital waveform —

digital waveform returns the converted digital waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Binary U16 to Digital VI


Converts a binary array of unsigned integers to a digital waveform or set of digital data.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• binary array —

binary array is the 1D array of unsigned 16-bit integers you want to convert to a digital
waveform or set of digital data.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital data —

digital data returns the converted set of digital data.

• error out —

1380 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

DWDT Binary U8 to Digital VI


Converts a binary array of unsigned integers to a digital waveform or set of digital data.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• binary array —

binary array is the 1D array of unsigned 8-bit integers you want to convert to a digital waveform
or set of digital data.

• sample rate —

sample rate specifies the frequency in samples per second of the output digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital waveform —

digital waveform returns the converted digital waveform.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 1381


Functions

DTbl Binary U8 to Digital VI


Converts a binary array of unsigned integers to a digital waveform or set of digital data.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• binary array —

binary array is the 1D array of unsigned 8-bit integers you want to convert to a digital waveform
or set of digital data.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• digital data —

digital data returns the converted set of digital data.

• error out —

error out contains error information. This output provides standard error out functionality.

Spreadsheet String to Digital


Converts a spreadsheet string to a digital waveform or set of digital data. You must
manually select the polymorphic instance you want to use.

1382 ni.com
Functions

• DWDT Spreadsheet String to Digital VI


• DTbl Spreadsheet String to Digital VI

DWDT Spreadsheet String to Digital VI


Converts a spreadsheet string to a digital waveform or set of digital data. You must
manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• spreadsheet string —

spreadsheet string contains numeric or string values separated into columns by delimiters, such
as tabs or commas, with an end-of-line (EOL) character separating rows. spreadsheet string
should be a delimited list of ASCII characters representing the 8 supported digital data states,
shown in the following table.

Digital
Value Description
Data State
0 (Drive
0 Force logic low. Drive to the low voltage level (VOL).
Low)
1 (Drive
1 Force logic high. Drive to the high voltage level (VOH).
High)
Z (Force
2 Force logic high impedance. Turn the driver off.
Off)

© National Instruments 1383


Functions

Digital
Value Description
Data State
L
Compare logic low (edge). Compare for a voltage level lower than the low
3 (Compare
voltage threshold.
Low)
H
Compare logic high (edge). Compare for a voltage level higher than the high
4 (Compare
voltage threshold (VOH).
High)
X
5 (Compare Compare logic unknown. Do not compare.
Unknown)
T
Compare logic high impedance (edge). Compare for a voltage level between
6 (Compare
the low voltage threshold (VOL) and the high voltage threshold (VOH).
Off)
V
Compare logic valid level (edge). Compare for a voltage level either lower than
7 (Compare
the low voltage threshold (VOL) or higher than the high voltage threshold (VOH).
Valid)

• delimiter (tab) —

delimiter is the value or values used to separate fields in the spreadsheet file. The default is a
single tab character.

• sample rate —

sample rate specifies the frequency in samples per second of the output digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• position first column —

position first column specifies whether the first column from spreadsheet string represents the
least significant bit (LSB) or most significant bit (MSB) of the waveform.

• digital waveform —

digital waveform returns the converted digital waveform.

• error out —

1384 ni.com
Functions

error out contains error information. This output provides standard error out functionality.

DTbl Spreadsheet String to Digital VI


Converts a spreadsheet string to a digital waveform or set of digital data. You must
manually select the polymorphic instance you want to use.

Inputs/Outputs
• compress data (T) —

compress data specifies whether to compress the digital output. The default is TRUE.

• spreadsheet string —

spreadsheet string contains numeric or string values separated into columns by delimiters, such
as tabs or commas, with an end-of-line (EOL) character separating rows. spreadsheet string
should be a delimited list of ASCII characters representing the 8 supported digital data states,
shown in the following table.

Digital
Value Description
Data State
0 (Drive
0 Force logic low. Drive to the low voltage level (VOL).
Low)
1 (Drive
1 Force logic high. Drive to the high voltage level (VOH).
High)
Z (Force
2 Force logic high impedance. Turn the driver off.
Off)
L
Compare logic low (edge). Compare for a voltage level lower than the low
3 (Compare
voltage threshold.
Low)
4 H Compare logic high (edge). Compare for a voltage level higher than the high

© National Instruments 1385


Functions

Digital
Value Description
Data State
(Compare
voltage threshold (VOH).
High)
X
5 (Compare Compare logic unknown. Do not compare.
Unknown)
T
Compare logic high impedance (edge). Compare for a voltage level between
6 (Compare
the low voltage threshold (VOL) and the high voltage threshold (VOH).
Off)
V
Compare logic valid level (edge). Compare for a voltage level either lower than
7 (Compare
the low voltage threshold (VOL) or higher than the high voltage threshold (VOH).
Valid)

• delimiter (tab) —

delimiter is the value or values used to separate fields in the spreadsheet file. The default is a
single tab character.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• position first column —

position first column specifies whether the first column from spreadsheet string represents the
least significant bit (LSB) or most significant bit (MSB) of the waveform.

• digital data —

digital data returns the converted set of digital data.

• error out —

error out contains error information. This output provides standard error out functionality.

Digital to Boolean Array


Converts the digital waveform or digital data in the digital input to a 2D Boolean array.

1386 ni.com
Functions

Wire data to the digital waveform input to determine the polymorphic instance to use
or manually select the instance.

• DWDT Digital to Boolean Array VI


• DTbl Digital to Boolean Array VI

DWDT Digital to Boolean Array VI


Converts the digital waveform or digital data in the digital input to a 2D Boolean array.
Wire data to the digital waveform input to determine the polymorphic instance to use
or manually select the instance.

Inputs/Outputs
• digital waveform —

digital waveform is the input digital waveform.

• response on error —

response on error specifies what to do if any value in the digital input is not a 0, 1, H, or L.

Warn but Convert (default)—Any values that are not 0, 1, H, or L are converted to FALSE and a
0
warning is returned in error out.
1 Fail—boolean array is returned empty and an error is returned in error out.

• mode —

mode specifies whether the conversion is performed on the data with the least significant bit
(LSB) first or most significant bit (MSB) first. The order of the Boolean values in boolean array

© National Instruments 1387


Functions

reflects the selection made in mode.

LSB First
0
(default)
1 MSB First

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• boolean array —

boolean array returns the converted Boolean array. The order of the Boolean values in boolean
array reflects the bit direction selected in mode.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Digital to Boolean Array VI


Converts the digital waveform or digital data in the digital input to a 2D Boolean array.
Wire data to the digital waveform input to determine the polymorphic instance to use
or manually select the instance.

Inputs/Outputs
• digital data —

digital data is the set of input digital data.

1388 ni.com
Functions

• response on error —

response on error specifies what to do if any value in the digital input is not a 0, 1, H, or L.

Warn but Convert (default)—Any values that are not 0, 1, H, or L are converted to FALSE and a
0
warning is returned in error out.
1 Fail—boolean array is returned empty and an error is returned in error out.

• mode —

mode specifies whether the conversion is performed on the data with the least significant bit
(LSB) first or most significant bit (MSB) first. The order of the Boolean values in boolean array
reflects the selection made in mode.

LSB First
0
(default)
1 MSB First

• error in (no error) —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• boolean array —

boolean array returns the converted Boolean array. The order of the Boolean values in boolean
array reflects the bit direction selected in mode.

• error out —

error out contains error information. This output provides standard error out functionality.

Digital to Binary
Converts a digital waveform or set of digital data to a binary array of unsigned integers.
You must manually select the polymorphic instance you want to use.

© National Instruments 1389


Functions

• DWDT Digital to Binary U32 VI


• DTbl Digital to Binary U32 VI
• DWDT Digital to Binary U16 VI
• DTbl Digital to Binary U16 VI
• DWDT Digital to Binary U8 VI
• DTbl Digital to Binary U8 VI

DWDT Digital to Binary U32 VI


Converts a digital waveform or set of digital data to a binary array of unsigned integers.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• digital waveform —

digital waveform is the input digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• binary array —

binary array is the array resulting from the conversion of the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

1390 ni.com
Functions

DTbl Digital to Binary U32 VI


Converts a digital waveform or set of digital data to a binary array of unsigned integers.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• digital data —

digital data is the set of input digital data.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• binary array —

binary array is the array resulting from the conversion of the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

DWDT Digital to Binary U16 VI


Converts a digital waveform or set of digital data to a binary array of unsigned integers.
You must manually select the polymorphic instance you want to use.

© National Instruments 1391


Functions

Inputs/Outputs
• digital waveform —

digital waveform is the input digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• binary array —

binary array is the array resulting from the conversion of the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Digital to Binary U16 VI


Converts a digital waveform or set of digital data to a binary array of unsigned integers.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• digital data —

digital data is the set of input digital data.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• binary array —

1392 ni.com
Functions

binary array is the array resulting from the conversion of the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

DWDT Digital to Binary U8 VI


Converts a digital waveform or set of digital data to a binary array of unsigned integers.
You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• digital waveform —

digital waveform is the input digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• binary array —

binary array is the array resulting from the conversion of the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

DTbl Digital to Binary U8 VI


Converts a digital waveform or set of digital data to a binary array of unsigned integers.

© National Instruments 1393


Functions

You must manually select the polymorphic instance you want to use.

Inputs/Outputs
• digital data —

digital data is the set of input digital data.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• binary array —

binary array is the array resulting from the conversion of the digital input.

• error out —

error out contains error information. This output provides standard error out functionality.

Waveform File I/O

Use the Waveform File I/O VIs to write waveform data to and read waveform data from
files.

The VIs on this palette can return waveform error codes.

Palette
Description
Object
Write
Waveforms Creates a new file or appends to an existing file, writes the specified number of
to File

1394 ni.com
Functions

Palette
Description
Object

records to the file, then closes the file and checks for errors. Each record is an array of
waveforms. Wire data to the Waveform input to determine the polymorphic instance
to use or manually select the instance.

Read Opens a file created with the Write Waveforms to File VI and reads one record of the
Waveforms file. Each record might contain one or more separate waveforms. To retrieve all
from File records in the file, call this VI in a loop until the end of the file is reached.

Export
Waveforms Converts a waveform to a text string and writes the string to a new byte stream file or
to appends the string to an existing file. Wire data to the waveforms input to determine
Spreadsheet the polymorphic instance to use or manually select the instance.
File

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Write Waveforms to


File.vi

Write Waveforms to File

Creates a new file or appends to an existing file, writes the specified number of records
to the file, then closes the file and checks for errors. Each record is an array of
waveforms. Wire data to the Waveform input to determine the polymorphic instance
to use or manually select the instance.

You can use any file extension, for example .dat or .txt, for the file you write the
waveform data to.

© National Instruments 1395


Functions

• Write Waveform to File VI


• Write Waveforms to File (1D) VI
• Write Waveforms to File (2D) VI
• Write Waveform to File (Digital) VI

Write Waveform to File VI


Creates a new file or appends to an existing file, writes the specified number of records
to the file, then closes the file and checks for errors. Each record is an array of
waveforms. Wire data to the Waveform input to determine the polymorphic instance
to use or manually select the instance.

You can use any file extension, for example .dat or .txt, for the file you write the
waveform data to.

Inputs/Outputs
• file path (dialog if empty) —

file path specifies the file where the waveform is located. If you do not wire this input, LabVIEW
displays a non-native file dialog box instead of a native file dialog box.

• waveform —

waveform is the waveform you want to write to a file.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

1396 ni.com
Functions

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• error out —

error out contains error information. This output provides standard error out functionality.

Write Waveforms to File (1D) VI


Creates a new file or appends to an existing file, writes the specified number of records
to the file, then closes the file and checks for errors. Each record is an array of
waveforms. Wire data to the Waveform input to determine the polymorphic instance
to use or manually select the instance.

You can use any file extension, for example .dat or .txt, for the file you write the
waveform data to.

Inputs/Outputs
• file path (dialog if empty) —

file path specifies the file where the waveform is located. If you do not wire this input, LabVIEW
displays a non-native file dialog box instead of a native file dialog box.

• waveform array —

waveform array is a 1D array of the waveforms you want to write to a file.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• error in (no error) —

© National Instruments 1397


Functions

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• error out —

error out contains error information. This output provides standard error out functionality.

Write Waveforms to File (2D) VI


Creates a new file or appends to an existing file, writes the specified number of records
to the file, then closes the file and checks for errors. Each record is an array of
waveforms. Wire data to the Waveform input to determine the polymorphic instance
to use or manually select the instance.

You can use any file extension, for example .dat or .txt, for the file you write the
waveform data to.

Inputs/Outputs
• file path (dialog if empty) —

file path specifies the file where the waveform is located. If you do not wire this input, LabVIEW
displays a non-native file dialog box instead of a native file dialog box.

• waveform array —

waveform array is a 2D array of the waveforms you want to write to a file.

• append to file? (new file:F) —

1398 ni.com
Functions

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• error out —

error out contains error information. This output provides standard error out functionality.

Write Waveform to File (Digital) VI


Creates a new file or appends to an existing file, writes the specified number of records
to the file, then closes the file and checks for errors. Each record is an array of
waveforms. Wire data to the Waveform input to determine the polymorphic instance
to use or manually select the instance.

You can use any file extension, for example .dat or .txt, for the file you write the
waveform data to.

Inputs/Outputs
• file path (dialog if empty) —

file path specifies the file where the waveform is located. If you do not wire this input, LabVIEW
displays a non-native file dialog box instead of a native file dialog box.

• waveform —

© National Instruments 1399


Functions

waveform is the digital waveform you want to write to a file.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• error out —

error out contains error information. This output provides standard error out functionality.

Read Waveforms from File

Opens a file created with the Write Waveforms to File VI and reads one record of the
file. Each record might contain one or more separate waveforms. To retrieve all records
in the file, call this VI in a loop until the end of the file is reached.

This VI returns an end-of-file error in the error out output.

• Read Waveform from File VI


• Read Waveform from File (Digital) VI

Read Waveform from File VI


Opens a file created with the Write Waveforms to File VI and reads one record of the
file. Each record might contain one or more separate waveforms. To retrieve all records

1400 ni.com
Functions

in the file, call this VI in a loop until the end of the file is reached.

This VI returns an end-of-file error in the error out output.

Inputs/Outputs
• file path (dialog if empty) —

file path specifies the file where the waveform is located. If you do not wire this input, LabVIEW
displays a non-native file dialog box instead of a native file dialog box.

• offset (records:0) —

offset specifies in records which record to read from the file. The first record is 0. The default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• first waveform in record —

first waveform in record returns the data of the first waveform in the record.

• all waveforms in record —

all waveforms in record returns the data from all waveforms in the record. If there is only one
waveform in the record, this output is identical to first waveform in record.

• error out —

error out contains error information. This output provides standard error out functionality.

© National Instruments 1401


Functions

Read Waveform from File (Digital) VI


Opens a file created with the Write Waveforms to File VI and reads one record of the
file. Each record might contain one or more separate waveforms. To retrieve all records
in the file, call this VI in a loop until the end of the file is reached.

This VI returns an end-of-file error in the error out output.

Inputs/Outputs
• file path (dialog if empty) —

file path specifies the file where the waveform is located. If you do not wire this input, LabVIEW
displays a non-native file dialog box instead of a native file dialog box.

• offset (records:0) —

offset specifies in records which record to read from the file. The first record is 0. The default is 0.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• digital waveform —

digital waveform returns the data of the first waveform in the record.

• error out —

error out contains error information. This output provides standard error out functionality.

1402 ni.com
Functions

Export Waveforms to Spreadsheet File

Converts a waveform to a text string and writes the string to a new byte stream file or
appends the string to an existing file. Wire data to the waveforms input to determine
the polymorphic instance to use or manually select the instance.

• Export Waveforms To Spreadsheet File (1D) VI


• Export Waveforms To Spreadsheet File (2D) VI
• Export Waveform To Spreadsheet File VI
• Export Waveforms To Spreadsheet File (Digital) VI

This VI opens or creates the file beforehand and closes it afterwards. You can use this VI
to create a text file readable by most spreadsheet applications.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Write Waveforms to


File.vi

Export Waveforms To Spreadsheet File (1D)


VI
Converts a waveform to a text string and writes the string to a new byte stream file or
appends the string to an existing file. Wire data to the waveforms input to determine
the polymorphic instance to use or manually select the instance.

© National Instruments 1403


Functions

Inputs/Outputs
• delimiter (Tab) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , specifies a single comma as the delimiter, and a carriage return
specifies a new line as the delimiter. The default specifies a single tab character as the delimiter.
You also can use backslash ('\') codes to specify a delimiter by right-clicking the string control or
constant and selecting '\' Codes Display from the shortcut menu.

• prompt —

prompt is the prompt of the file save dialog if the file path is empty.

The default is Choose file to write.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• waveforms —

waveforms contains the waveforms to export to the spreadsheet file.

• multiple time columns? (single:F) —

If multiple time columns? is TRUE, the VI writes separate time columns for each separate
channel written to the file. If multiple time columns? is FALSE (default), a single time column
represents the same time range for all waveforms written to the file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

1404 ni.com
Functions

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• header? (write header:T) —

If header? (write header:T) is TRUE (default), the VI prints column and row headings, which
contain time and date information and labels for the data. If header? is FALSE, the VI does not
print column and row headings.

• new file path (Not A Path if cancelled) —

new file path (Not A Path if cancelled) is the path of the file to which the VI wrote data. You can
use this output to determine the path of a file that you opened using a dialog box. new file path
is <Not A Path> if you cancelled the dialog box.

• error out —

error out contains error information. This output provides standard error out functionality.

This VI opens or creates the file beforehand and closes it afterwards. You can use this VI
to create a text file readable by most spreadsheet applications.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Write Waveforms to


File.vi

Export Waveforms To Spreadsheet File (2D)


VI
Converts a waveform to a text string and writes the string to a new byte stream file or
appends the string to an existing file. Wire data to the waveforms input to determine
the polymorphic instance to use or manually select the instance.

© National Instruments 1405


Functions

Inputs/Outputs
• delimiter (Tab) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , specifies a single comma as the delimiter. The default specifies a single
tab character as the delimiter.

• prompt —

prompt is the prompt of the file save dialog if the file path is empty.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• waveforms —

waveforms contains the waveforms to export to the spreadsheet file.

• multiple time columns? (single:F) —

If multiple time columns? is TRUE, the VI writes separate time columns for each separate
channel written to the file. If multiple time columns? is FALSE (default), a single time column
represents the same time range for all waveforms written to the file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• append to file? (new file:F) —

1406 ni.com
Functions

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• header? (write header:T) —

If header? (write header:T) is TRUE (default), the VI prints column and row headings, which
contain time and date information and labels for the data. If header? is FALSE, the VI does not
print column and row headings.

• new file path (Not A Path if cancelled) —

new file path (Not A Path if cancelled) is the path of the file to which the VI wrote data. You can
use this output to determine the path of a file that you opened using a dialog box. new file path
is <Not A Path> if you cancelled the dialog box.

• error out —

error out contains error information. This output provides standard error out functionality.

This VI opens or creates the file beforehand and closes it afterwards. You can use this VI
to create a text file readable by most spreadsheet applications.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Write Waveforms to


File.vi

Export Waveform To Spreadsheet File VI


Converts a waveform to a text string and writes the string to a new byte stream file or
appends the string to an existing file. Wire data to the waveforms input to determine
the polymorphic instance to use or manually select the instance.

© National Instruments 1407


Functions

Inputs/Outputs
• delimiter (Tab) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , specifies a single comma as the delimiter, and a carriage return
specifies a new line as the delimiter. The default specifies a single tab character as the delimiter.
You also can use backslash ('\') codes to specify a delimiter by right-clicking the string control or
constant and selecting '\' Codes Display from the shortcut menu.

• prompt —

prompt is the prompt of the file save dialog if the file path is empty.

The default is Choose file to write.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• waveform —

waveform is the waveform to export to the spreadsheet file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• header? (write header:T) —

1408 ni.com
Functions

If header? (write header:T) is TRUE (default), the VI prints column and row headings, which
contain time and date information and labels for the data. If header? is FALSE, the VI does not
print column and row headings.

• new file path (Not A Path if cancelled) —

new file path (Not A Path if cancelled) is the path of the file to which the VI wrote data. You can
use this output to determine the path of a file that you opened using a dialog box. new file path
is <Not A Path> if you cancelled the dialog box.

• error out —

error out contains error information. This output provides standard error out functionality.

This VI opens or creates the file beforehand and closes it afterwards. You can use this VI
to create a text file readable by most spreadsheet applications.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Write Waveforms to


File.vi

Export Waveforms To Spreadsheet File


(Digital) VI
Converts a waveform to a text string and writes the string to a new byte stream file or
appends the string to an existing file. Wire data to the waveforms input to determine
the polymorphic instance to use or manually select the instance.

© National Instruments 1409


Functions

Inputs/Outputs
• delimiter (Tab) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , specifies a single comma as the delimiter, and a carriage return
specifies a new line as the delimiter. The default specifies a single tab character as the delimiter.
You also can use backslash ('\') codes to specify a delimiter by right-clicking the string control or
constant and selecting '\' Codes Display from the shortcut menu.

• prompt —

prompt is the prompt of the file save dialog if the file path is empty.

The default is Choose file to write.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• Digital Waveform —

digital waveform is the input digital waveform.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• header? (write header:T) —

1410 ni.com
Functions

If header? (write header:T) is TRUE (default), the VI prints column and row headings, which
contain time and date information and labels for the data. If header? is FALSE, the VI does not
print column and row headings.

• new file path (Not A Path if cancelled) —

new file path (Not A Path if cancelled) is the path of the file to which the VI wrote data. You can
use this output to determine the path of a file that you opened using a dialog box. new file path
is <Not A Path> if you cancelled the dialog box.

• error out —

error out contains error information. This output provides standard error out functionality.

This VI opens or creates the file beforehand and closes it afterwards. You can use this VI
to create a text file readable by most spreadsheet applications.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Waveform\Waveform - Write Waveforms to


File.vi

Collection
Use the Collection VIs and functions to manipulate collection data.

Palette Object Description

Map Use the Map VIs and functions to create and manipulate maps.

Set Use the Set VIs and functions to create and manipulate sets.

© National Instruments 1411


Functions

Map

Use the Map VIs and functions to create and manipulate maps.

Palette
Description
Object
Creates a map from the input key-value entries. For entries with duplicate keys, this
Build Map
function includes only the last entry in the resulting map.
Insert Into Inserts a key and its associated value into a map. If the key is already included in the
Map map, this function replaces the original value of the key with the new associated
Function value.
Remove
From Map Removes a key and its associated value from a map.
Function
Look In
Checks whether a map includes an entry with the specified key and returns the
Map
associated value of the key.
Function
Read Map
Max & Min
Returns the maximum and minimum keys in a map.
Keys
Function
Represents a map on the block diagram. You cannot modify the embedded data in a
map interactively or programmatically. You can update map data only as a whole
Map
through operations such as writing to the map front panel terminal or right-clicking
Constant
the map and selecting Data Operations>>Copy Data or Data Operations>>Paste
Data.
Collection
Size Returns the number of elements or entries in a collection.
Function
Empty
Collection? Returns TRUE if the input collection contains zero elements or entries.
Function

1412 ni.com
Functions

Palette
Description
Object
Convert
Map To Places the code that you can use to convert a map to an array.
Array

In Place Places an In Place Element structure on the block diagram with the Map Get / Replace
Map Access Value border node added.

Use the Registration Map VIs to create and manipulate registration maps. A
Registration
registration map is a map between a key and a set of elements with operations to
Map
signal when clients register or unregister for one or more services.

Build Map

Creates a map from the input key-value entries. For entries with duplicate keys, this
function includes only the last entry in the resulting map.

Inputs/Outputs
• key —

key specifies the key of the entry. This input accepts any data type. All the keys must be unique
and of the same data type.

• value —

value specifies the value of the entry. This input accepts any data type. All the values must be of
the same data type.

• map —

© National Instruments 1413


Functions

map returns the resulting map.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Comparing


Test Results.vi

Insert Into Map Function

Inserts a key and its associated value into a map. If the key is already included in the
map, this function replaces the original value of the key with the new associated value.

Inputs/Outputs
• map in —

map in specifies the map in which you want to insert a key-value entry. This input accepts a map
of any data type. The default data type is a map of 32-bit signed integers.

• key —

key specifies the key of the entry to insert into the map.

The key must be of the same data type as the existing keys in the map.

• value —

value specifies the value of the entry. This input must be of the same data type as the existing
values in the map.

• map out —

map out returns the map with the inserted entry.

1414 ni.com
Functions

• key already included? —

key already included? returns whether map in already includes key. If key already included? is
TRUE, this function replaces the associated value of key in map in with value and returns the
resulting map in map out.

• value unchanged? —

value unchanged? returns whether any values in the input map are updated after the insertion.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Comparing


Test Results.vi

Remove From Map Function

Removes a key and its associated value from a map.

Inputs/Outputs
• map in —

map in specifies the map from which you want to remove an entry. This input accepts a map of
any data type. The default data type is a map of 32-bit signed integers.

• key —

key specifies the key of the entry to remove. This input must be of the same data type as the
existing keys in the map.

• map out —

map out returns the map with the entry of the specified key removed.

© National Instruments 1415


Functions

• key not found? —

key not found? returns whether map in includes an entry with the specified key.

• value —

value returns the value of the entry associated with key.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Word


Counting.vi

Look In Map Function

Checks whether a map includes an entry with the specified key and returns the
associated value of the key.

Inputs/Outputs
• map —

map specifies the map in which you want to look for a key. This input accepts a map of any data
type. The default data type is a map of 32-bit signed integers.

• key —

key specifies the key to look for in the map. The key must be of the same data type as the
existing keys in the map.

• default value —

default value specifies the value to return in value if the specified key does not exist in the map.
This input must be of the same data type as the existing values in the map.

1416 ni.com
Functions

• key not found? —

key not found? returns TRUE if map does not include an entry with the specified key. Otherwise,
key not found? returns FALSE.

• value —

value returns the value of the entry with the associated key if key not found? is FALSE. If key not
found? is TRUE, this output returns the value in default value.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Comparing


Test Results.vi
• labview\examples\Design Patterns\Registration Map\
Registration Map Usage.lvproj

Read Map Max & Min Keys Function

Returns the maximum and minimum keys in a map.

Inputs/Outputs
• map —

map specifies the map in which you want to look for the maximum and minimum keys. This
input accepts a map of any data type. The default data type is a map of 32-bit signed integers.

• maximum —

maximum returns the maximum key in map.

• minimum —

© National Instruments 1417


Functions

minimum returns the minimum key in map.

Map Constant

Represents a map on the block diagram. You cannot modify the embedded data in a
map interactively or programmatically. You can update map data only as a whole
through operations such as writing to the map front panel terminal or right-clicking
the map and selecting Data Operations>>Copy Data or Data Operations>>Paste Data.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Word


Counting.vi

Collection Size Function

Returns the number of elements or entries in a collection.

Inputs/Outputs
• collection —

collection specifies the collection. This input accepts any collection data type.

• size —

size returns the number of elements or entries in collection.

1418 ni.com
Functions

Empty Collection? Function

Returns TRUE if the input collection contains zero elements or entries.

Inputs/Outputs
• collection —

collection specifies the collection. This input accepts any collection data type.

• empty? —

empty? returns TRUE if collection is empty. Otherwise, this output returns FALSE.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Comparing


Test Results.vi
• labview\examples\Collections\Set Collection - Word
Counting.vi
• labview\examples\Design Patterns\Registration Map\
Registration Map Usage.lvproj

Convert Map To Array

Places the code that you can use to convert a map to an array.

When you add this VI to the block diagram, a For Loop displays. Wire a map to the
tunnel input and return an array through the tunnel output.

© National Instruments 1419


Functions

In Place Map Access

Places an In Place Element structure on the block diagram with the Map Get / Replace
Value border node added.

Registration Map

Use the Registration Map VIs to create and manipulate registration maps. A registration
map is a map between a key and a set of elements with operations to signal when
clients register or unregister for one or more services.

Palette Object Description

Registration Adds a set element in a registration map. This VI signals the calling VI if it is
Map:Register the first time any set element has registered for this key.

Registration
Checks if a set element is registered for a key in a registration map. This VI
Map:Confirm
signals the calling VI if the set element has registered for the key.
Registration

Registration Removes an entry from a registration map. This VI signals the calling VI if the
Map:Unregister given element is the last element registered for this key.

1420 ni.com
Functions

Registration Map:Register
Adds a set element in a registration map. This VI signals the calling VI if it is the first
time any set element has registered for this key.

Inputs/Outputs
• map in —

map in specifies the registration map in which you want to insert an entry. This input accepts a
map of sets of any data type. The default data type is a map of sets of 32-bit signed integers.

• key —

key specifies the key. This input must be of the same data type as the existing keys in the map.

• set element —

set element specifies the set element that may be registered for the specified key. This input
must be of the same data type as the elements of the sets in the map.

• map out —

map out returns the registration map with the inserted entry.

• element already registered? —

element already registered? returns whether map in already includes set element.

• first registration for this key? —

first registration for this key? returns whether this is the first time that the key is registered.

Examples

Refer to the following example files included with LabVIEW.

© National Instruments 1421


Functions

• labview\examples\Design Patterns\Registration Map\


Registration Map Usage.lvproj

Registration Map:Confirm Registration


Checks if a set element is registered for a key in a registration map. This VI signals the
calling VI if the set element has registered for the key.

Inputs/Outputs
• map —

map specifies the registration map in which you want to check for the registration status of a set
element. This input accepts a map of sets of any data type. The default data type is a map of sets
of 32-bit signed integers.

• key —

key specifies the key. This input must be of the same data type as the existing keys in the map.

• set element —

set element specifies the set element that may be registered for the specified key. This input
must be of the same data type as the elements of the sets in the map.

• is element registered for key? —

is element registered for key? returns whether the set element has been registered for the key.

Registration Map:Unregister
Removes an entry from a registration map. This VI signals the calling VI if the given
element is the last element registered for this key.

1422 ni.com
Functions

Inputs/Outputs
• map in —

map in specifies the registration map from which you want to remove an element. This input
accepts a map of sets of any data type. The default data type is a map of sets of 32-bit signed
integers.

• key —

key specifies the key. This input must be of the same data type as the existing keys in the map.

• set element —

set element specifies the set element that may be registered for the specified key. This input
must be of the same data type as the elements of the sets in the map.

• map out —

map out returns the registration map with the specified entry removed.

• element not registered for this key? —

element not registered for this key? returns whether the specified set element has been
registered for the specified key.

• removed last registration for this key? —

removed last registration for this key? returns whether the specified set of elements is the last
set of elements registered for this key.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Design Patterns\Registration Map\


Registration Map Usage.lvproj

© National Instruments 1423


Functions

Set

Use the Set VIs and functions to create and manipulate sets.

Palette
Description
Object
Creates a set from the input elements. Duplicate elements appear only once in the
Build Set
resulting set.
Insert Into
Set Inserts an element into a set.
Function
Remove
From Set Removes an element from a set.
Function
Element of
Set? Returns whether an element is a member of a set.
Function
Read Set
Max & Min Returns the maximum and minimum elements in a set.
Function
Represents a set on the block diagram. You cannot modify the embedded data in a set
Set interactively or programmatically. You can update set data only as a whole through
Constant operations such as writing to the set front panel terminal or right-clicking the set and
selecting Data Operations>>Copy Data or Data Operations>>Paste Data.
Collection
Size Returns the number of elements or entries in a collection.
Function
Empty
Collection? Returns TRUE if the input collection contains zero elements or entries.
Function

Convert Set
Places the code that you can use to convert a set to an array.
To Array

1424 ni.com
Functions

Palette
Description
Object

Computes the union of two sets. The union is all elements that belong to either of the
Set Union
two sets.

Set Computes the intersection of two sets. The intersection is all the elements that
Intersection belong to both sets.

Set Computes the Cartesian product of two sets. The Cartesian product is a set of
Cartesian 2-element clusters which covers all possible combinations of elements from the two
Product sets.

Set Computes the difference of two sets. The difference is the elements from the first set
Difference that are not included in the second set.

Set
Symmetric Computes the symmetric difference of two sets.
Difference

Build Set

Creates a set from the input elements. Duplicate elements appear only once in the
resulting set.

Inputs/Outputs
• element —

element specifies the data you want to include in the set.

This input accepts any data type. The default data type is string. All the element inputs must be

© National Instruments 1425


Functions

of the same data type.

• set —

set returns the resulting set.

Insert Into Set Function

Inserts an element into a set.

Inputs/Outputs
• set in —

set in specifies the set in which you want to insert an element. This input accepts a set of any
data type. The default data type is a set of strings.

• element —

element specifies the data you want to insert into the set. This input must be of the same data
type as the existing elements in the set.

• set out —

set out returns the set with the inserted element.

• already included? —

already included? returns whether set in already includes the inserted element. If already
included? is TRUE, set out returns the same set as set in.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Set Collection - Word

1426 ni.com
Functions

Counting.vi
• labview\examples\Design Patterns\Registration Map\
Registration Map Usage.lvproj

Remove From Set Function

Removes an element from a set.

Inputs/Outputs
• set in —

set in specifies the set in which you want to remove an element. This input accepts a set of any
data type. The default data type is a set of strings.

• element —

element specifies the data you want to remove from the set. This input must be of the same data
type as the elements in the set.

• set out —

set out returns the set with the specified element removed.

• not included? —

not included? returns whether set in includes element. If not included? is TRUE, set out returns
the same set as set in.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Design Patterns\Registration Map\


Registration Map Usage.lvproj

© National Instruments 1427


Functions

Element of Set? Function

Returns whether an element is a member of a set.

Inputs/Outputs
• set —

set specifies the set. This input accepts a set of any data type. The default data type is a set of
strings.

• element —

element specifies the data to look for in the set. This input must be of the same data type as the
elements in set.

• found? —

found? returns TRUE if element is included in set. Otherwise, found? returns FALSE.

Read Set Max & Min Function

Returns the maximum and minimum elements in a set.

Inputs/Outputs
• set —

set specifies the set. This input accepts a set of any data type. The default data type is a set of
strings.

• maximum —

1428 ni.com
Functions

maximum returns the maximum element in set.

• minimum —

minimum returns the minimum element in set.

Set Constant

Represents a set on the block diagram. You cannot modify the embedded data in a set
interactively or programmatically. You can update set data only as a whole through
operations such as writing to the set front panel terminal or right-clicking the set and
selecting Data Operations>>Copy Data or Data Operations>>Paste Data.

Collection Size Function

Returns the number of elements or entries in a collection.

Inputs/Outputs
• collection —

collection specifies the collection. This input accepts any collection data type.

• size —

size returns the number of elements or entries in collection.

Empty Collection? Function

Returns TRUE if the input collection contains zero elements or entries.

© National Instruments 1429


Functions

Inputs/Outputs
• collection —

collection specifies the collection. This input accepts any collection data type.

• empty? —

empty? returns TRUE if collection is empty. Otherwise, this output returns FALSE.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Map Collection - Comparing


Test Results.vi
• labview\examples\Collections\Set Collection - Word
Counting.vi
• labview\examples\Design Patterns\Registration Map\
Registration Map Usage.lvproj

Convert Set To Array

Places the code that you can use to convert a set to an array.

When you add this VI to the block diagram, a For Loop displays. Wire a set to the tunnel
input and return an array through the tunnel output.

1430 ni.com
Functions

Set Union

Computes the union of two sets. The union is all elements that belong to either of the
two sets.

Inputs/Outputs
• set 1 —

set 1 specifies the first set. This input accepts a set of any data type. The default data type is a set
of strings.

• set 2 —

set 2 specifies the second set. This input must be the same data type as set 1. The default data
type is a set of strings.

• union —

union returns the combined set.

The following figure illustrates how this VI computes the union of two sets. The two
circles represent the two sets. The green section is the union.

© National Instruments 1431


Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Set Collection - Word


Counting.vi

Set Intersection

Computes the intersection of two sets. The intersection is all the elements that belong
to both sets.

Inputs/Outputs
• set 1 —

set 1 specifies the first set. This input accepts a set of any data type. The default data type is a set
of strings.

• set 2 —

set 2 specifies the second set. This input must be the same data type as set 1. The default data
type is a set of strings.

• intersection —

intersection returns a set with the duplicate elements from the two input sets.

The following figure illustrates how this VI computes the intersection of two sets. The
two circles represent the two sets. The green section is the intersection.

1432 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Set Collection - Word


Counting.vi

Set Cartesian Product

Computes the Cartesian product of two sets. The Cartesian product is a set of
2-element clusters which covers all possible combinations of elements from the two
sets.

Inputs/Outputs
• set 1 —

set 1 specifies the first set. This input accepts a set of any data type. The default data type is a set
of strings.

• set 2 —

set 2 specifies the second set. This input accepts a set of any data type. The default data type is a
set of strings.

• Cartesian product —

© National Instruments 1433


Functions

Cartesian product returns a set of 2-element clusters which covers all possible combinations of
elements in set 1 and set 2. For each cluster, the first element is from set 1 and the second
element is from set 2.

Set Difference

Computes the difference of two sets. The difference is the elements from the first set
that are not included in the second set.

Inputs/Outputs
• set 1 —

set 1 specifies the first set. This input accepts a set of any data type. The default data type is a set
of strings.

• set 2 —

set 2 specifies the second set. This input must be the same data type as set 1. The default data
type is a set of strings.

• difference —

difference returns a set of elements from set 1 that are not included in set 2.

The following figure illustrates how this VI computes the difference of two sets. The
two circles represent the two sets. The green section is the difference.

1434 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Set Collection - Word


Counting.vi

Set Symmetric Difference

Computes the symmetric difference of two sets.

Inputs/Outputs
• set 1 —

set 1 specifies the first set. This input accepts a set of any data type. The default data type is a set
of strings.

• set 2 —

set 2 specifies the second set. This input must be the same data type as set 1. The default data
type is a set of strings.

• symmetric difference —

symmetric difference returns a set of elements that are included in either set 1 or set 2 but not

© National Instruments 1435


Functions

both.

The following figure illustrates how this VI computes the symmetric difference of two
sets. The two circles represent the two sets. The green sections are the symmetric
difference.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Collections\Set Collection - Word


Counting.vi

File I/O
Use the File I/O VIs and functions to open and close files, read from and write to files,
create directories and files you specify in the path control, retrieve directory
information, and write strings, numbers, arrays, and clusters to files.

Use the VIs and functions on this palette to perform common I/O operations and other
types of file I/O operations. You can read or write various types of data, such as
characters or lines in text files, numeric values in spreadsheet text files, or data in
binary files.

The File I/O palette and the Advanced File palette include functions to control each file
I/O operation individually. Use these functions to create or open a file, read data from

1436 ni.com
Functions

or write data to the file, and close the file. You also can use the functions to create
directories; move, copy, or delete files; list directory contents; change file
characteristics; or manipulate paths.

Palette
Description
Object

Converts a 2D or 1D array of strings, signed integers, or double-precision numbers


to a text string and writes the string to a new byte stream file or appends the string
Write
to an existing file. Wire data to the 2D data input or 1D data input to determine the
Delimited
polymorphic instance to use or manually select the instance.
Spreadsheet
Use this VI to transpose or separate data.

Reads a specified number of lines or rows from a numeric text file beginning at a
Read
specified character offset and converts the data to a 2D, double-precision array of
Delimited
numbers, strings, or integers. You must manually select the polymorphic instance
Spreadsheet
you want to use.

Write To
Writes data to text-based measurement files (.lvm), binary measurement files
Measurement
(.tdm or .tdms), or Microsoft Excel files (.xlsx).
File

Read From
Reads data from a text-based measurement file (.lvm) or binary measurement file
Measurement
(.tdm or .tdms).
File

Open/Create/ Opens an existing file, creates a new file, or replaces an existing file,
Replace File programmatically or interactively using a file dialog box. This function does not
Function work for files inside an LLB.
Close File Closes an open file specified by refnum and returns the path to the file associated
Function with the refnum.
Formats string, numeric, path, or Boolean data as text and writes the text to a file. If
Format Into
you wire a file refnum to the file input, writing begins at the current file position. To
File
append to an existing file, open the file and set the file position to the end of the file

© National Instruments 1437


Functions

Palette
Description
Object
by using the Set File Position function. Otherwise, the function will open the file and
write to the beginning of the file. This function does not work for files inside an LLB.
Scans text in a file for string, numeric, path, and Boolean data, converts the text to a
Scan From
data type, and returns a duplicated refnum and the converted outputs in the order
File
scanned. This function does not work for files inside an LLB.
Write to Text Writes a string or an array of strings as lines to a file. This function does not work for
File Function files inside an LLB.
Read from
Reads a specified number of characters or lines from a byte stream file. This
Text File
function does not work for files inside an LLB.
Function
Write to
Writes binary data to a new file, appends data to an existing file, or replaces the
Binary File
contents of a file. This function does not work for files inside an LLB.
Function
Read from
Reads binary data from a file and returns it in data. How the data is read depends on
Binary File
the format of the specified file. This function does not work for files inside an LLB.
Function
Build Path
Creates a new path by appending a name or a relative path to an existing path.
Function
Strip Path Returns the name of the last component of a path and the stripped path that leads
Function to that component.

File
Use the file constants with the File I/O VIs and functions.
Constants

Configuration Use the Configuration File VIs to create, modify, and read a platform-independent
File VIs configuration file.

TDM Use the TDM Streaming VIs and functions to read and write waveforms and
Streaming waveform properties to binary measurement files (.tdms).

Storage/ Use the Storage/DataPlugin VIs to read measurement data from a variety of file
DataPlugin formats, write data to .tdm or .tdms files, or manage DataPlugins installed on the

1438 ni.com
Functions

Palette
Description
Object

local computer. You must download appropriate DataPlugins and register them on
the local computer before you can access the corresponding file formats. Refer to
the National Instruments website at ni.com/dataplugins to download DataPlugins.

Use the Zip VIs to create new zip files, to add files to zip files, to unzip zip files, and
Zip
to close zip files.

XML Use the XML VIs and functions to manipulate XML data.

Waveform Use the Waveform File I/O VIs to write waveform data to and read waveform data
File I/O from files.

Advanced
File Use the Advanced File VIs and functions to manipulate files, directories, and paths.
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\Arrays\Array to Spreadsheet String.vi

Write Delimited Spreadsheet

Converts a 2D or 1D array of strings, signed integers, or double-precision numbers to a


text string and writes the string to a new byte stream file or appends the string to an
existing file. Wire data to the 2D data input or 1D data input to determine the
polymorphic instance to use or manually select the instance.

Use this VI to transpose or separate data.

Note To format with Microsoft Excel, use ActiveX with LabVIEW or the Report
Generation Toolkit for Microsoft Office.

© National Instruments 1439


Functions

• Write Delimited Spreadsheet (DBL) VI


• Write Delimited Spreadsheet (I64) VI
• Write Delimited Spreadsheet (string) VI

When you use this VI to write the data, the VI opens or creates the file before writing to
it and closes it afterwards. You can use this VI to create a text file readable by most
spreadsheet applications. This VI calls the Array To Spreadsheet String function to
convert the data.

Write Delimited Spreadsheet (DBL) VI

Converts a 2D or 1D array of strings, signed integers, or double-precision numbers to a


text string and writes the string to a new byte stream file or appends the string to an
existing file. Wire data to the 2D data input or 1D data input to determine the
polymorphic instance to use or manually select the instance.

Use this VI to transpose or separate data.

Note To format with Microsoft Excel, use ActiveX with LabVIEW or the Report
Generation Toolkit for Microsoft Office.

Inputs/Outputs
• format (%.3f) —

format specifies how to convert the numbers to characters.

1440 ni.com
Functions

If the format is %.3f (default), the VI creates a string long enough to contain the number, with
three digits to the right of the decimal point. If format is %d, the VI converts the data to integer
form using as many characters as necessary to contain the entire number. If format is %s, the VI
copies the input string. Use the format string syntax.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• 2D data —

2D data specifies the data to write to the file if 1D data is not wired or is empty.

• 1D data —

1D data specifies the data to write to the file if this input is not empty.

The VI converts the 1D array into a 2D array before proceeding.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• transpose? (no:F) —

transpose? specifies whether the VI transposes the data after converting it from a string.

The default is FALSE. If transpose? is FALSE, each call to this VI creates a new line or row in the
file.

• delimiter (\t) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , (comma) specifies a single comma as the delimiter. The default is \t,
which specifies a single tab character as the delimiter.

© National Instruments 1441


Functions

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• error out —

error out contains error information. This output provides standard error out functionality.

When you use this VI to write the data, the VI opens or creates the file before writing to
it and closes it afterwards. You can use this VI to create a text file readable by most
spreadsheet applications. This VI calls the Array To Spreadsheet String function to
convert the data.

Write Delimited Spreadsheet (I64) VI

Converts a 2D or 1D array of strings, signed integers, or double-precision numbers to a


text string and writes the string to a new byte stream file or appends the string to an
existing file. Wire data to the 2D data input or 1D data input to determine the
polymorphic instance to use or manually select the instance.

Use this VI to transpose or separate data.

Note To format with Microsoft Excel, use ActiveX with LabVIEW or the Report
Generation Toolkit for Microsoft Office.

Inputs/Outputs
• format (%d) —

format specifies how to convert the numbers to characters.

1442 ni.com
Functions

If format is %d (default), the VI converts the data to integer form using as many characters as
necessary to contain the entire number. If the format is %.3f, the VI creates a string long
enough to contain the number, with three digits to the right of the decimal point. If format is %s,
the VI copies the input string. Use the format string syntax.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• 2D data —

2D data specifies the data to write to the file if 1D data is not wired or is empty.

• 1D data —

1D data specifies the data to write to the file if this input is not empty.

The VI converts the 1D array into a 2D array before proceeding.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• transpose? (no:F) —

transpose? specifies whether the VI transposes the data after converting it from a string.

The default is FALSE. If transpose? is FALSE, each call to this VI creates a new line or row in the
file.

• delimiter (\t) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , (comma) specifies a single comma as the delimiter. The default is \t,
which specifies a single tab character as the delimiter.

© National Instruments 1443


Functions

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• error out —

error out contains error information. This output provides standard error out functionality.

When you use this VI to write the data, the VI opens or creates the file before writing to
it and closes it afterwards. You can use this VI to create a text file readable by most
spreadsheet applications. This VI calls the Array To Spreadsheet String function to
convert the data.

Write Delimited Spreadsheet (string) VI

Converts a 2D or 1D array of strings, signed integers, or double-precision numbers to a


text string and writes the string to a new byte stream file or appends the string to an
existing file. Wire data to the 2D data input or 1D data input to determine the
polymorphic instance to use or manually select the instance.

Use this VI to transpose or separate data.

Note To format with Microsoft Excel, use ActiveX with LabVIEW or the Report
Generation Toolkit for Microsoft Office.

Inputs/Outputs
• format (%s) —

format specifies how to convert the numbers to characters.

1444 ni.com
Functions

If format is %s (default), the VI copies the input string. If the format is %.3f, the VI creates a
string long enough to contain the number, with three digits to the right of the decimal point. If
format is %d, the VI converts the data to integer form using as many characters as necessary to
contain the entire number. Use the format string syntax.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• 2D data —

2D data specifies the data to write to the file if 1D data is not wired or is empty.

• 1D data —

1D data specifies the data to write to the file if this input is not empty.

The VI converts the 1D array into a 2D array before proceeding.

• append to file? (new file:F) —

append to file? appends data to an existing file, if TRUE. If append to file? is FALSE (default), the
VI replaces data in an existing file. If there is no existing file, the VI creates a new file.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• transpose? (no:F) —

transpose? specifies whether the VI transposes the data after converting it from a string.

The default is FALSE. If transpose? is FALSE, each call to this VI creates a new line or row in the
file.

• delimiter (\t) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , (comma) specifies a single comma as the delimiter. The default is \t,
which specifies a single tab character as the delimiter.

© National Instruments 1445


Functions

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• error out —

error out contains error information. This output provides standard error out functionality.

When you use this VI to write the data, the VI opens or creates the file before writing to
it and closes it afterwards. You can use this VI to create a text file readable by most
spreadsheet applications. This VI calls the Array To Spreadsheet String function to
convert the data.

Read Delimited Spreadsheet

Reads a specified number of lines or rows from a numeric text file beginning at a
specified character offset and converts the data to a 2D, double-precision array of
numbers, strings, or integers. You must manually select the polymorphic instance you
want to use.

You optionally can transpose the array. The VI opens the file before reading from it and
closes it afterwards. You can use this VI to read a spreadsheet file saved in text format.
This VI calls the Spreadsheet String to Array function to convert the data.

• Read Delimited Spreadsheet (DBL) VI


• Read Delimited Spreadsheet (I64) VI
• Read Delimited Spreadsheet (string) VI

Read Delimited Spreadsheet (DBL) VI

Reads a specified number of lines or rows from a numeric text file beginning at a
specified character offset and converts the data to a 2D, double-precision array of
numbers, strings, or integers. You must manually select the polymorphic instance you
want to use.

1446 ni.com
Functions

You optionally can transpose the array. The VI opens the file before reading from it and
closes it afterwards. You can use this VI to read a spreadsheet file saved in text format.
This VI calls the Spreadsheet String to Array function to convert the data.

Inputs/Outputs
• format (%.3f) —

format specifies how to convert the numbers to characters.

If the format is %.3f (default), the VI creates a string long enough to contain the number, with
three digits to the right of the decimal point. If format is %d, the VI converts the data to integer
form using as many characters as necessary to contain the entire number. If format is %s, the VI
copies the input string. Use the format string syntax.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• number of rows (all:-1) —

number of rows is the maximum number of rows or lines the VI reads.

For this VI, a row is a character string ending with a carriage return, linefeed, or a carriage return
followed by a linefeed; a string ending at the end of file; or a string that has the maximum line
length specified by the max characters per row input. If number of rows is <0, the VI reads the
entire file. The default is –1.

• start of read offset (chars.:0) —

start of read offset specifies the position in the file, in characters (bytes), at which the VI begins
reading.

© National Instruments 1447


Functions

The offset unit is bytes rather than numbers because byte stream files can contain segments of
different types of data. Therefore, to read an array of 100 numbers that follows a header of 57
characters, set start of read offset to 57.

• max characters/row (no limit:0) —

max characters/row is the maximum number of characters the VI reads before ending the
search for the end of a row or line.

The default is 0, which means that there is no limit to the number of characters the VI reads.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• transpose? (F) —

transpose? specifies whether the VI transposes the data after converting it from a string.

The default is FALSE.

• delimiter (\t) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , (comma) specifies a single comma as the delimiter. The default is \t,
which specifies a single tab character as the delimiter.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• all rows —

all rows is the data read from the file.

• first row —

first row is the first row of the all rows array.

You can use this output when you want to read one row into a 1D array.

• mark after read (chars.) —

1448 ni.com
Functions

mark after read returns the character (byte) in the file following the last character read.

• error out —

error out contains error information. This output provides standard error out functionality.

• EOF? —

EOF? is TRUE if you attempt to read past the end of file.

Read Delimited Spreadsheet (I64) VI

Reads a specified number of lines or rows from a numeric text file beginning at a
specified character offset and converts the data to a 2D, double-precision array of
numbers, strings, or integers. You must manually select the polymorphic instance you
want to use.

You optionally can transpose the array. The VI opens the file before reading from it and
closes it afterwards. You can use this VI to read a spreadsheet file saved in text format.
This VI calls the Spreadsheet String to Array function to convert the data.

Inputs/Outputs
• format (%d) —

format specifies how to convert the numbers to characters.

If format is %d (default), the VI converts the data to integer form using as many characters as
necessary to contain the entire number. If the format is %.3f, the VI creates a string long
enough to contain the number, with three digits to the right of the decimal point. If format is %s,
the VI copies the input string. Use the format string syntax.

© National Instruments 1449


Functions

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• number of rows (all:-1) —

number of rows is the maximum number of rows or lines the VI reads.

For this VI, a row is a character string ending with a carriage return, linefeed, or a carriage return
followed by a linefeed; a string ending at the end of file; or a string that has the maximum line
length specified by the max characters per row input. If number of rows is <0, the VI reads the
entire file. The default is –1.

• start of read offset (chars.:0) —

start of read offset specifies the position in the file, in characters (bytes), at which the VI begins
reading.

The offset unit is bytes rather than numbers because byte stream files can contain segments of
different types of data. Therefore, to read an array of 100 numbers that follows a header of 57
characters, set start of read offset to 57.

• max characters/row (no limit:0) —

max characters/row is the maximum number of characters the VI reads before ending the
search for the end of a row or line.

The default is 0, which means that there is no limit to the number of characters the VI reads.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• transpose? (F) —

transpose? specifies whether the VI transposes the data after converting it from a string.

The default is FALSE.

• delimiter (\t) —

1450 ni.com
Functions

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , (comma) specifies a single comma as the delimiter. The default is \t,
which specifies a single tab character as the delimiter.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• all rows —

all rows is the data read from the file.

• first row —

first row is the first row of the all rows array.

You can use this output when you want to read one row into a 1D array.

• mark after read (chars.) —

mark after read returns the character (byte) in the file following the last character read.

• error out —

error out contains error information. This output provides standard error out functionality.

• EOF? —

EOF? is TRUE if you attempt to read past the end of file.

Read Delimited Spreadsheet (string) VI

Reads a specified number of lines or rows from a numeric text file beginning at a
specified character offset and converts the data to a 2D, double-precision array of
numbers, strings, or integers. You must manually select the polymorphic instance you
want to use.

You optionally can transpose the array. The VI opens the file before reading from it and
closes it afterwards. You can use this VI to read a spreadsheet file saved in text format.
This VI calls the Spreadsheet String to Array function to convert the data.

© National Instruments 1451


Functions

Inputs/Outputs
• format (%s) —

format specifies how to convert the numbers to characters.

If format is %s (default), the VI copies the input string. If the format is %.3f, the VI creates a
string long enough to contain the number, with three digits to the right of the decimal point. If
format is %d, the VI converts the data to integer form using as many characters as necessary to
contain the entire number. Use the format string syntax.

• file path (dialog if empty) —

file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI
displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog
box.

• number of rows (all:-1) —

number of rows is the maximum number of rows or lines the VI reads.

For this VI, a row is a character string ending with a carriage return, linefeed, or a carriage return
followed by a linefeed; a string ending at the end of file; or a string that has the maximum line
length specified by the max characters per row input. If number of rows is <0, the VI reads the
entire file. The default is –1.

• start of read offset (chars.:0) —

start of read offset specifies the position in the file, in characters (bytes), at which the VI begins
reading.

The offset unit is bytes rather than numbers because byte stream files can contain segments of
different types of data. Therefore, to read an array of 100 numbers that follows a header of 57
characters, set start of read offset to 57.

• max characters/row (no limit:0) —

1452 ni.com
Functions

max characters/row is the maximum number of characters the VI reads before ending the
search for the end of a row or line.

The default is 0, which means that there is no limit to the number of characters the VI reads.

• error in (no error) —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• transpose? (F) —

transpose? specifies whether the VI transposes the data after converting it from a string.

The default is FALSE.

• delimiter (\t) —

delimiter is the character or string of characters to use to separate fields in the spreadsheet file.
For example, a value of , (comma) specifies a single comma as the delimiter. The default is \t,
which specifies a single tab character as the delimiter.

• new file path (Not A Path if cancelled) —

new file path returns the path to the file.

• all rows —

all rows is the data read from the file.

• first row —

first row is the first row of the all rows array.

You can use this output when you want to read one row into a 1D array.

• mark after read (chars.) —

mark after read returns the character (byte) in the file following the last character read.

• error out —

error out contains error information. This output provides standard error out functionality.

• EOF? —

© National Instruments 1453


Functions

EOF? is TRUE if you attempt to read past the end of file.

Write To Measurement File

Writes data to text-based measurement files (.lvm), binary measurement files (.tdm
or .tdms), or Microsoft Excel files (.xlsx).

Use the Read From Measurement File Express VI to read data from the generated
measurement file.

Dialog Box Options

Option Description

Displays the full path to the file to which you want to write data. The Express VI writes
data to the file that this parameter specifies only if the Filename input is unwired. If
Filename
you wire the Filename input, the VI writes data to the file that this input specifies
instead.

Contains the following options:

• Binary with XML Header (TDM)—

(Windows) Sets the file format to binary measurement file (.tdm) and the file
extension in Filename to .tdm.
File Format
If you select this option, the Delimiter section and the No headers option in the
Segment Headers section are not available.

When you select this file format, you enable the Lock file for faster access
checkbox. Selecting this checkbox makes reading and writing significantly faster

1454 ni.com
Functions

Option Description

(at the expense of the ability to multitask certain activities). It is recommended


that you use this option in most cases.

Note When this option is enabled, no two Express VIs can access the
same file at the same time when one of them is writing a "series of
files."

• Binary (TDMS)—

Sets the file format to binary measurement file (.tdms) and the file extension in
Filename to .tdms.

If you select this option, the Delimiter section and the No headers option in the
Segment Headers section are not available.

• Text (LVM)—

Sets the file format to text-based measurement file (.lvm) and the file extension
in Filename to .lvm.

• Microsoft Excel (.xlsx)—

Sets the file format to Microsoft Excel (.xlsx) and the file extension in Filename
to .xlsx.

If you select this option, the Delimiter section and the Segment Headers section
are unavailable.

Note This option does not require Microsoft Excel installed on the
local computer.

Contains the following options:

• Save to one file—


Action
Saves all the data to one file.

• Ask user to choose file—

© National Instruments 1455


Functions

Option Description

Displays a dialog box that prompts users to select a file. This option is available
only when you select the Save to one file option.

• Ask only once—

Prompts users to select a file only once. This option is available only when you
place a checkmark in the Ask user to choose file checkbox.

• Ask each iteration—

Prompts users to select a file each time the Express VI runs. This option is
available only when you place a checkmark in the Ask user to choose file
checkbox.

• Save to series of files (multiple files)—

Saves the data to multiple files. If Reset is TRUE, the VI starts at the first file in the
series. For example, if test_001.lvm has been saved to test_004.lvm,
test_001.lvm might be renamed, overwritten, or skipped based on the value
of the Existing Files option in the Configure Multi-file Settings dialog box.

• Settings—

Displays the Configure Multi-file Settings dialog box. This option is available only
when you select the Save to series of files (multiple files) option.

Contains the following options:

• Rename existing file—

Renames the existing file if Reset is TRUE.

• Use next available filename—


If a file
already
Appends the next sequential number to the filename if Reset is TRUE.
exists
For example, if test.lvm exists, LabVIEW saves the file as test1.lvm.

• Append to file—

Appends the data to the existing file.

1456 ni.com
Functions

Option Description

The VI ignores the value of Reset if you select the Append to file option.

Note When you append data to an existing Excel file, errors might
occur if the Excel file was not created by this Express VI. This option
does not support appending data to an Excel file that was created by a
third-party application.

• Overwrite file—

Replaces data in an existing file if Reset is TRUE.

Contains the following options:

• One header per segment—

Creates one header per segment in the file to which LabVIEW writes the data.
Select this option if the acquisition rate of the data changes over time, if you
acquire two or more signals at different acquisition rates, or if the list of signals
you log changes over time.

• One header only—

Segment Creates only one header in the file to which LabVIEW writes the data. Select this
Headers option if you acquire the same list of signals at the same constant acquisition
rate.

• No headers—

Creates an empty column for the time data each channel generates. This option
does not include the data from the x-axis.

Note This option is available only when you select the Text (LVM)
option from the File Format section.

Contains the following options:

X Value • One column per channel—


Columns
Creates a separate column for time data each channel generates. This option

© National Instruments 1457


Functions

Option Description

includes a column of values from the x-axis for every column of values from the y-
axis. Select this option if you acquire signals of different types or at different
acquisition rates.

• One column only—

Creates only one column for the time data the channels generate. This option
includes only one column of values from the x-axis. Select this option if you
acquire signals at the same acquisition rate.

• Empty time column—

Does not create a header in the file to which LabVIEW writes the data.

Contains the following options:

• Tab—

Uses tabs to delimit fields in the text file.

• Comma—
Delimiter
Uses commas to delimit fields in the text file.

Note These options are available only when you select the Text (LVM)
option from the File Format section.

Contains the description of the measurement file. LabVIEW appends the text you
enter in this text box to the header of the file. This text box is unavailable when you
select the Microsoft Excel (.xlsx) option from the File Format section.

• Advanced—
File
Description Displays the Configure User Defined Properties dialog box when you select the
Binary (TDMS) or Binary with XML Header (TDM) option from the File Format
section. Displays the Configure Advanced Excel Options dialog box when you
select the Microsoft Excel (.xlsx) option. This button is unavailable when you
select the Text (LVM) option.

1458 ni.com
Functions

Inputs/Outputs
• error in (no error) —

Describes error conditions that occur before this node runs.

• Comment —

Appends a comment to each data set written to the measurement file. This input is unavailable
when you select the Microsoft Excel (.xlsx) option from the File Format section.

• new_file —

If TRUE, stops writing to the current file, creates the next file in the series, and writes to that file
instead. This input is available only when you select the Save to series of files (multiple files)
option.

• Signals —

Contains the input signal or signals.

If you wire two or more signals with the same name to the Signals input, LabVIEW appends an
integer to the end of the names written in the file, which enforces unique channel names. For
example, if you wire two signals named Sine to the Signals input, LabVIEW writes the names as
Sine and Sine 1.

Note To change or customize how a signal name displays, use the Set Dynamic Data
Attributes Express VI.

• Flush? (T) — Specifies whether LabVIEW writes data to the Microsoft Excel file each time
after this Express VI runs. If the value is FALSE, LabVIEW does not write the data to the Microsoft
Excel file. Instead, LabVIEW stores the data in a temporary file. If the value is TRUE, LabVIEW
writes the data from the temporary file to the Excel file and then purges the temporary file. The
default is TRUE.

Note If you use this Express VI to write data iteratively, setting the Flush? input to
TRUE at each iteration might affect the writing performance negatively. National
Instruments recommends that you wire a FALSE value to this input until the last
iteration of the entire writing process. For the last iteration, you can wire a TRUE
value to this input to write all data to the Excel file.

• Filename —

© National Instruments 1459


Functions

Specifies the name of the file to which you want to write data. If Filename is not wired, the VI
uses the Filename specified in the configuration dialog box.

• DAQmx Task —

Specifies the DAQmx task to use to populate data on the DAQmx Properties page of the
Configure User Defined Properties dialog box.

• Reset — Specifies whether you want to reset the data file when you run this Express VI
iteratively. LabVIEW ignores this input when you run this Express VI in the first iteration. During
the second and subsequent iterations, if the value is FALSE, this Express VI appends data to a file
if the file already exists. Depending on your configuration for this Express VI, if the value is TRUE,
this Express VI renames, overwrites, or skips a file if the file already exists. The default is FALSE.
• Enable —

Enables or disables the Express VI. The default is ON or TRUE.

• error out —

Contains error information. This output provides standard error out functionality.

• Saving Data —

Indicates if the Express VI is saving the data.

• Filename Out —

Returns the name of the file.

Note The behavior of this VI changes depending upon the target. If the
current target does not or might not have a host computer connected, the
configuration dialog box displays warnings next to options that are invalid
without a host. If you configure this VI to prompt for input and run the VI on a
target with no user interface, such as the Real-Time Module with no host
computer connected, this VI returns an error.

You can also use the Storage/DataPlugin VIs to read from and write to .tdm files, or
you can use the TDM Streaming functions to read from and write to .tdms files.

1460 ni.com
Functions

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\TDMS\Express Read and Write\TDMS


Express Write Data (Time and Frequency Domain).vi
• labview\examples\File IO\TDMS\Express Read and Write\TDMS
Express Write Data (Time Domain).vi
• labview\examples\File IO\Spreadsheet\Excel\Write Excel
File.vi

Components

Displays the Configure User Defined Properties dialog box when you select the Binary
(TDMS) or Binary with XML Header (TDM) option from the File Format section.
Displays the Configure Advanced Excel Options dialog box when you select the
Microsoft Excel (.xlsx) option. This button is unavailable when you select the Text
(LVM) option.

Creates a separate column for time data each channel generates. This option includes
a column of values from the x-axis for every column of values from the y-axis. Select
this option if you acquire signals of different types or at different acquisition rates.

Creates only one column for the time data the channels generate. This option includes
only one column of values from the x-axis. Select this option if you acquire signals at
the same acquisition rate.

Creates an empty column for the time data each channel generates. This option does
not include the data from the x-axis.

Appends the data to the existing file.

Appends the next sequential number to the filename if Reset is TRUE.

Renames the existing file if Reset is TRUE.

Replaces data in an existing file if Reset is TRUE.

© National Instruments 1461


Functions

Does not create a header in the file to which LabVIEW writes the data.

Creates only one header in the file to which LabVIEW writes the data. Select this option
if you acquire the same list of signals at the same constant acquisition rate.

Creates one header per segment in the file to which LabVIEW writes the data. Select
this option if the acquisition rate of the data changes over time, if you acquire two or
more signals at different acquisition rates, or if the list of signals you log changes over
time.

Uses commas to delimit fields in the text file.

Uses tabs to delimit fields in the text file.

Prompts users to select a file each time the Express VI runs. This option is available
only when you place a checkmark in the Ask user to choose file checkbox.

Prompts users to select a file only once. This option is available only when you place a
checkmark in the Ask user to choose file checkbox.

Value that Number of samples uses. The default is 1.

Displays the Configure Multi-file Settings dialog box. This option is available only when
you select the Save to series of files (multiple files) option.

Saves the data to multiple files. If Reset is TRUE, the VI starts at the first file in the
series. For example, if test_001.lvm has been saved to test_004.lvm,
test_001.lvm might be renamed, overwritten, or skipped based on the value of the
Existing Files option in the Configure Multi-file Settings dialog box.

Saves all the data to one file.

Contains the description of the measurement file. LabVIEW appends the text you enter
in this text box to the header of the file. This text box is unavailable when you select
the Microsoft Excel (.xlsx) option from the File Format section.

Displays a dialog box that prompts users to select a file. This option is available only
when you select the Save to one file option.

1462 ni.com
Functions

Displays the full path to the file to which you want to write data. The Express VI writes
data to the file that this parameter specifies only if the Filename input is unwired. If
you wire the Filename input, the VI writes data to the file that this input specifies
instead.

(Windows) Sets the file format to binary measurement file (.tdm) and the file
extension in Filename to .tdm.

Sets the file format to binary measurement file (.tdms) and the file extension in
Filename to .tdms.

Sets the file format to text-based measurement file (.lvm) and the file extension in
Filename to .lvm.

Sets the file format to Microsoft Excel (.xlsx) and the file extension in Filename to
.xlsx.

Read From Measurement File

Reads data from a text-based measurement file (.lvm) or binary measurement file
(.tdm or .tdms).

Dialog Box Options

Option Description

Displays the full path to the file from which you want to read data. The Express VI reads
data from the file that this parameter specifies only if the Filename input is unwired. If
Filename
you wire the Filename input, the VI reads data from the file that this input specifies
instead.

© National Instruments 1463


Functions

Option Description
Contains the following options:

• Text (LVM)—

Sets the file format to text-based measurement file (.lvm) and the file extension in
File Name to .lvm.

To enable this VI to read data from generic text files, place a checkmark in the Read
generic text files checkbox.

• Binary (TDMS)—

Sets the file format to binary measurement file (.tdms) and the file extension in
File Name to .tdms.

If you select this option, the Time Stamps and Generic Text File sections are not
File available.
Format
• Binary with XML Header (TDM)—

(Windows) Sets the file format to binary measurement file (.tdm) and the file
extension in File Name to .tdm.

If you select this option, the Time Stamps and Generic Text File sections are not
available.

When you select this file format, you enable the Lock file for faster access
checkbox. Selecting this checkbox makes reading and writing significantly faster (at
the expense of the ability to multitask certain activities). It is recommended that
you use this option in most cases.

Note When this option is enabled, no two Express VIs can access the
same file at the same time when one of them is writing a "series of files."

Contains the following option:

• Ask user to choose file—


Action
Displays a dialog box that prompts users to select a file.

Segment Contains the following options:

1464 ni.com
Functions

Option Description

• Retrieve segments of original size—

Retrieves segments of the signal from the file in the original size.

• Retrieve segments of specified size—

Size Retrieves segments of the signal using the size you specify in Samples.

◦ Samples—

Specifies the number of samples you want to include in the segment size read
from the file. The default is 100. This option is available only when you select
the Retrieve segments of specified size option.

Contains the following options:

• Relative to start of measurement—

Displays the timestamp in terms of seconds starting from zero. For example, 100 in
relative time equals 1 minute and 40 seconds.

Time • Absolute (date and time)—


Stamps
Displays the timestamp in terms of time elapsed since 12:00 a.m., Friday, January 1,
1904, Universal Time [01-01-1904 00:00:00].

Note These options are available only when you select the Text (LVM) option
from the File Format section.

Contains the following options:

• Start row of numeric data—

Indicates the first row of numeric data. The Express VI begins reading data from this
Generic
row. The default is 1.
Text File
• First row is channel names—

Specifies that the channel names are in the first row of the data file.

© National Instruments 1465


Functions

Option Description

• First column is time channel—

Specifies that the time data for each channel are in the first column of the data file.

• Read File Now—

Imports the data from the file you specify in File Name into the Sample data table.

• Sample data—

Displays the data from the file you specify in File Name when you click the Read
File Now button.

Note These options are available only when you select the Text (LVM) option
from the File Format section.

Contains the following options:

• Tab—

Uses tabs to delimit fields in the text file.

• Comma—
Delimiter
Uses a comma as the decimal separator.

Note These options are available only when you select the Text (LVM) option
from the File Format section.

Contains the following options:

• . (dot)—

Decimal Uses a period as the decimal separator.


Point
• , (comma)—

Uses a comma as the decimal separator.

1466 ni.com
Functions

Option Description

Note These options are available only when you select the Text (LVM) option
from the File Format section.

Inputs/Outputs
• Enable —

Enables or disables the Express VI. The default is ON or TRUE.

• error in (no error) —

Describes error conditions that occur before this node runs.

• Filename —

Specifies the name of the file from which you want to read data.

• Reset —

Resets the file position such that the next read starts at the beginning of the file.

• Signals —

Contains the output signal or signals.

• Filename Out —

Returns the name of the file.

• Comment —

Returns the appended comment of each data set in the .lvm or .tdm file.

• error out —

Contains error information. This output provides standard error out functionality.

• Description —

Returns the description in the header of the .lvm or .tdm file.

© National Instruments 1467


Functions

• EOF? —

Returns TRUE when the Express VI reaches the end of the file.

You also can use this VI to read Multisim data if you have Multisim 9.0 or later installed.
Use the Write To Measurement File Express VI to write data to a measurement file. You
also can use the Storage/DataPlugin VIs to read from and write to .tdm files.

Note The behavior of this VI changes depending upon the target. If the
current target does not or might not have a host computer connected, the
configuration dialog box displays warnings next to options that are invalid
without a host. If you configure this VI to prompt for input and run the VI on a
target with no user interface, such as the Real-Time Module with no host
computer connected, this VI returns an error.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\TDMS\Express Read and Write\TDMS


Express Read Data (Time Domain).vi

Components

Specifies the number of samples you want to include in the segment size read from the
file. The default is 100. This option is available only when you select the Retrieve
segments of specified size option.

Contains the following options:

Retrieves segments of the signal using the size you specify in Samples.

Retrieves segments of the signal from the file in the original size.

Reads data from generic text files.

Displays the timestamp in terms of time elapsed since 12:00 a.m., Friday, January 1,

1468 ni.com
Functions

1904, Universal Time [01-01-1904 00:00:00].

Displays the timestamp in terms of seconds starting from zero. For example, 100 in
relative time equals 1 minute and 40 seconds.

Contains the following options:

Uses a comma as the decimal separator.

Uses a period as the decimal separator.

Contains the following options:

Uses commas to delimit fields in the text file.

Uses tabs to delimit fields in the text file.

Contains the following options:

(Windows) Sets the file format to binary measurement file (.tdm) and the file
extension in File Name to .tdm.

Sets the file format to binary measurement file (.tdms) and the file extension in File
Name to .tdms.

Sets the file format to text-based measurement file (.lvm) and the file extension in
File Name to .lvm.

Displays the full path to the file from which you want to read data. The Express VI reads
data from the file that this parameter specifies only if the Filename input is unwired. If
you wire the Filename input, the VI reads data from the file that this input specifies
instead.

Specifies that the time data for each channel are in the first column of the data file.

Specifies that the channel names are in the first row of the data file.

Imports the data from the file you specify in File Name into the Sample data table.

© National Instruments 1469


Functions

Displays the data from the file you specify in File Name when you click the Read File
Now button.

Specifies that the time data for each channel are in the first column of the data file.

Specifies that the channel names are in the first row of the data file.

Indicates the first row of numeric data. The Express VI begins reading data from this
row. The default is 1.

Retrieves segments of the signal using the size you specify in Samples.

Displays a dialog box that prompts users to select a file.

Open/Create/Replace File Function

Opens an existing file, creates a new file, or replaces an existing file, programmatically
or interactively using a file dialog box. This function does not work for files inside an
LLB.

Inputs/Outputs
• prompt —

prompt is the message that appears above the list of files and directories or folder in the file
dialog box.

• file path (use dialog) —

file path is the absolute path to the file.

If you do not wire file path, the function displays a dialog box from which you can select a file. If
you specify an empty or relative path, this function returns an error. If file path is the path to a

1470 ni.com
Functions

directory that does not exist, this function returns an error. Use the Create Folder function to
create a directory.

• operation (0:open) —

operation is the operation to perform. Error 43 occurs if you cancel the dialog box.

0 open (default)—Opens an existing file. Error 7 occurs if the file cannot be found.
1 replace—Replaces an existing file by opening the file and setting its end of file to 0.
2 create—Creates a new file. Error 10 occurs if the file already exists.
3 open or create—Opens an existing file or creates a new file if one does not exist.
replace or create—Creates a new file or replaces a file if it exists. This VI replaces a file by
4
opening the file and setting its end of file to 0.
replace or create with confirmation—Creates a new file or replaces a file if it exists and you
5
give permission. This VI replaces a file by opening the file and setting its end of file to 0.

• access (0:read/write) —

access specifies how you plan to access the file.

The default is read/write.

0 read/write
1 read-only
2 write-only

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• disable buffering (F) —

disable buffering specifies if the file opens without buffering. The default is FALSE.

If you want to read or write a data file to a Redundant Array of Independent Disks (RAID),
consider opening the file without buffering to speed up data transfers. To disable buffering, wire
a TRUE value to the disable buffering input.

Note If you have a small amount of data to transfer, you might not notice a

© National Instruments 1471


Functions

difference if you disable buffering.

(macOS and Linux) LabVIEW ignores this input.

• refnum out —

refnum out is the reference number of the open file.

The value is Not A Refnum if the file cannot be opened.

• cancelled —

cancelled is TRUE if you cancel the file dialog box or if you do not select the replacement in an
advisory dialog box.

• error out —

error out contains error information. This output provides standard error out functionality.

You can optionally specify a dialog prompt or default filename. Use this function with
the intermediate Write File or Read File functions. Use the Close File function to close
the reference to the file.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Spreadsheet\Tab-Delimited Data\


Tab-Delimited Data.lvproj

Close File Function

Closes an open file specified by refnum and returns the path to the file associated with
the refnum.

Error I/O operates uniquely in this function, which closes the file regardless of whether
an error occurred in a preceding operation. This ensures that files are closed correctly.

1472 ni.com
Functions

Inputs/Outputs
• refnum —

refnum is the file refnum associated with the file you want to close.

• error in —

error in describes error conditions that occur before this node runs. With the following
exception, this input provides standard error in functionality.

This node runs normally even if an error occurred before this node runs.

• path —

path is the corresponding path to refnum.

• error out —

error out contains error information. This output provides standard error out functionality.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Datalog\Datalog File.lvproj

Format Into File

Formats string, numeric, path, or Boolean data as text and writes the text to a file. If
you wire a file refnum to the file input, writing begins at the current file position. To
append to an existing file, open the file and set the file position to the end of the file by
using the Set File Position function. Otherwise, the function will open the file and write
to the beginning of the file. This function does not work for files inside an LLB.

© National Instruments 1473


Functions

Inputs/Outputs
• format string —

format string specifies how to convert the input arguments.

Defaults match the data type of the input arguments. Right-click the function and select Edit
Format String from the shortcut menu to create and edit the format string.

This input accepts a maximum of 255 characters.

• input file —

input file can be a refnum or absolute file path.

If it is a refnum, this node opens the file specified by the refnum. This function creates the
specified file if it does not already exist. The default is to display a file dialog box and prompt you
to select a file.

If you specify an empty or relative path, this function returns an error.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• input 1 —

input 1..n specifies the input parameters you want the function to convert.

This parameter accepts a string, path, enumerated type, time stamp, Boolean, or any numeric
data type. For complex numeric data types, this function converts only the real component. You
cannot use arrays and clusters with this function.

If you specify a Boolean value for this parameter and %s as the format code, the Format Into File
function outputs the value as TRUE or FALSE. If you specify a Boolean value for this parameter
and any numeric format code, the Format Into File function outputs the appropriate version of 1
for TRUE and 0 for FALSE. For example, if you specify %f as the format code, the function outputs

1474 ni.com
Functions

1.00000. If you specify %d, the function outputs 1.

• output file refnum —

output file refnum is the refnum of the file that the VI read.

You can wire this output to another file function, depending on what you want to do with the
file. The default is to close the file if it is referenced by a file path or selected from the file dialog
box. If input file is a refnum, LabVIEW assumes that the file is still in use until you close it.
• error out —

error out contains error information. This output provides standard error out functionality.

Increase the number of parameters by right-clicking the function and selecting Add
Parameter from the shortcut menu or by resizing the function.

You can use this function to determine the order in which the data appears in the file.

This function converts new lines, or \n, in the format string into the platform-specific
end-of-line character, for example, CR/LF on Windows, and LF on macOS and Linux. If
you do not want to convert new lines into the end-of-line character, use the Format
Into String function and wire the resulting string output to the text input of the Write
to Text File function. Then right-click the Write to Text File function and remove the
checkmark next to the Convert EOL shortcut menu item.

Specifying Which Input to Use within the Format String

By default, this function uses the order of the inputs to populate the format specifiers,
or percent codes, in the Format String. However, you can use a number followed by a
dollar sign ($) within a percent code to specify exactly which input to use for that
percent code. For example, the percent code %3$d uses the third input regardless of
how many percent codes appear before it in the format string.

As a further example, refer to the following block diagram:

© National Instruments 1475


Functions

The following input combinations illustrate the effects of the $ specifier:

Input Format Data in


Input 2 Comments
1 String Output File

first Format String does not use the $ specifier, so the


first second %s %s
second function populates the percent codes in input order.
%2$s second Format String uses the $ specifier to display the
first second
%1$s first inputs in a different order than their input order.
%1$s first
Format String uses the $ specifier to display the first
first second %1$s first
input multiple times and ignore the second input.
%1$s first

You can use other special characters besides the $ to configure how this function
populates the percent codes in format string.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Text (ASCII)\Format Into File


and Scan From File.vi

Scan From File

Scans text in a file for string, numeric, path, and Boolean data, converts the text to a
data type, and returns a duplicated refnum and the converted outputs in the order
scanned. This function does not work for files inside an LLB.

You can use this function to read all the text in the file. However, you cannot use this
function to determine a starting point for the scan. To do so, use the Read from Text

1476 ni.com
Functions

File function and the Scan From String function.

Inputs/Outputs
• format string —

format string specifies how to convert the input string into the output arguments.

The default is to scan the string according to default behavior for the data types of the outputs
wired. Right-click the function and select Edit Scan String from the shortcut menu to create and
edit the format string.

This input accepts a maximum of 255 characters.

• input file —

input file can be a refnum or absolute file path.

If it is a refnum, this node opens the file specified by the refnum. This function creates the
specified file if it does not already exist. The default is to display a file dialog box and prompt you
to select a file.

If you specify an empty or relative path, this function returns an error.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• default value 1 —

default 1..n specifies the type and default value for the output parameters.

If this function cannot scan the input value from format string, the function uses the default. If
you do not wire default 1 and you wire a constant to format string, the function uses format
string to determine the type of the output. Otherwise, the default data type is double-precision,
floating-point. The default value is 0 or an empty string, depending on the output data type. If

© National Instruments 1477


Functions

you wire an enumerated type to default 1, the function finds substrings matching the string
values in the enumerated type and returns the corresponding numeric value of the enumerated
type.

You can scan for Boolean values if you use a string or numeric format code. If the format code is
%s or unwired, the function reads Y, T, TRUE, ON, or YES and any lowercase versions of those
words as TRUE Boolean values. The function reads F, FALSE, OFF, or NO and any lowercase
versions of those words as FALSE Boolean values. If you specify a numeric format code, the
function reads any numeric value greater than 0.5 as TRUE and any numeric value less than or
equal to 0.5 as FALSE.

Note This function reads negative numbers as FALSE Boolean values because the
function converts the number to an unsigned 8-bit integer and any number less than
or equal to 0.5 becomes 0 during the conversion.

• output file refnum —

output file refnum is the refnum of the file that the VI read.

You can wire this output to another file function, depending on what you want to do with the
file. The default is to close the file if it is referenced by a file path or selected from the file dialog
box. If input file is a refnum, LabVIEW assumes that the file is still in use until you close it.
• error out —

error out contains error information. This output provides standard error out functionality.

• output 1 —

output 1..n specifies the output parameters.

Each output can be a string, path, enumerated type, time stamp, Boolean, or any numeric data
type. If you scan a string that does not fit into the numeric data type you specify, this function
returns the largest number that fits into that data type. You cannot use arrays and clusters with
this function.

Increase the number of parameters by right-clicking the function and selecting Add
Parameter from the shortcut menu or by resizing the function.

Note If an error occurs, the source component of the error out cluster
contains a string of the form ''Scan From File (arg n),'' where n
is the first argument for which the error occurred.

1478 ni.com
Functions

If you wire a block diagram constant string to format string, LabVIEW uses format
string to determine the number of outputs and the data type of each output at
compile time. If the types you wire to the outputs do not match the types determined
by format string, you must change the output types before the VI can run.

If you do not directly wire a block diagram constant to format string, LabVIEW checks
for type mismatches at run time. If you want to scan values that have data types other
than double-precision, floating point, you must wire the data types to default 1..n.

When you use the match characters not in set format specifier (%[^...]), which is
used frequently to read an entire string, the matched character(s) are left in the file
stream. %[^\n\r] matches an entire line of text, but the carriage return and new line
are left behind. To remove these characters, use %[^\n\r]\n\r.

Note By default, this function is locale aware, which means that it uses the
system decimal separator configured in the regional settings of the operating
system. In some instances, such as using GPIB instruments on European
operating systems, you may need to override the system decimal separator
by using the localization code syntax elements.

Examples of Formatting Strings

format remaining
input string default(s) output(s)
string string
— abc
abc, xyz — xyz
%3s,
00
%s%f%2d 0+00i 12.3+56i
>12.3+56i 7200
— 72
Q+1.27E–3 tail Q%f t — 1.27E–3 ail
12
0123456789 %3d%3d — 6789
345
100 (I32) 10
X:9.860 Z:3.450 X:%fY:%f Z: 3450
100.00 (DBL) 100.00
set49.4.2 set%d — 49 .4.2

© National Instruments 1479


Functions

format remaining
input string default(s) output(s)
string string
blue (enum {red, green,
color: red color: %s red —
blue})
abcd
%[a-z]%d 12
abcd012xyz3 — —
%[a-z]%d xyz
3
welcome to
welcome to LabVIEW, LabVIEW
%[^,],%s — Smith
John Smith
John

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Text (ASCII)\Format Into File


and Scan From File.vi

Write to Text File Function

Writes a string or an array of strings as lines to a file. This function does not work for
files inside an LLB.

Use the Set File Position function if you need to perform random access file reads or
writes.

Inputs/Outputs
• prompt (Choose or enter file path) —

1480 ni.com
Functions

prompt is the message that appears above the list of files and directories or folder in the file
dialog box.

• file (use dialog) —

file can be a refnum or absolute file path.

If you wire a path to the file input, the function opens or creates the file before writing to it and
replaces any previous file contents. If you wire a file refnum to the file input, writing begins at
the current file position. To append to an existing file, set the file position to the end of the file by
using the Set File Position function. The default is to display a file dialog box and prompt you to
select a file.

If you specify an empty or relative path, this function returns an error. If you specify a path to a
hidden file, this function returns an error.

• text —

text is the data the function writes to the file. text is a string or an array of strings.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• refnum out —

refnum out is the refnum of the file that the function read. You can wire this output to another
file function, depending on what you want to do with the file. The default is to close the file if it is
referenced by a file path or selected from the file dialog box. If file is a refnum or if you wire
refnum out to another function, LabVIEW assumes that the file is still in use until you close it.

• cancelled —

cancelled is TRUE if you cancel the file dialog box.

Otherwise, cancelled is FALSE, even if this function returns an error.


• error out —

error out contains error information. This output provides standard error out functionality.

This function appends platform-dependent, end-of-line (EOL) characters to the


elements of an array even if you right-click the function and remove the checkmark

© National Instruments 1481


Functions

next to the Convert EOL shortcut menu item.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Text (ASCII)\Write to Text File


and Read from Text File.vi

Read from Text File Function

Reads a specified number of characters or lines from a byte stream file. This function
does not work for files inside an LLB.

Inputs/Outputs
• prompt (Open existing file) —

prompt is the message that appears above the list of files and directories, or folder, in the file
dialog box.

• file (use dialog) —

file can be a refnum or absolute file path.

If it is a path, this function opens the file specified by the path. The default is to display a file
dialog box and prompt you to select a file.

If you specify an empty or relative path or if the file does not exist, this function returns an error.

• count —

count is the maximum number of characters or lines the function reads.

The function reads fewer characters or lines if it reaches the end of file first. If count is <0, the
function reads the entire file starting from the current file position. The default is to read a single

1482 ni.com
Functions

line if you placed a checkmark next to the Read Lines shortcut menu item and to read the entire
file if you removed the checkmark next to the item.

Note If you wire a file size with a data type other than a 32-bit integer to count,
LabVIEW coerces the data type to a 32-bit integer. This means the VI may not read the
amount of data you intend. If you wire –1 to count and the size of the file you want to
read is too large to be represented by a 32-bit integer, LabVIEW returns an error.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• refnum out —

refnum out is the refnum of the file that the function read. You can wire this output to another
file function, depending on what you want to do with the file. The default is to close the file if it is
referenced by a file path or selected from the file dialog box. If file is a refnum or if you wire
refnum out to another function, LabVIEW assumes that the file is still in use until you close it.

• text —

text is the text read from the file. By default, this parameter is a string that contains the
characters read from the first line of the file. If you wire count, this parameter is an array of
strings that contains the lines read from the file. If you right-click the function and remove the
checkmark next to the Read Lines shortcut menu item, this parameter is a string that contains
the characters read from the file.

• cancelled —

cancelled is TRUE if you cancel the file dialog box.

Otherwise, cancelled is FALSE, even if this function returns an error.


• error out —

error out contains error information. This output provides standard error out functionality.

This function opens files as read-only. If you wire the refnum out output of this
function to the file input of a write function, LabVIEW returns a permissions error. Use
the Open/Create/Replace File function to open the file with the default read/write
access and wire the refnum to the read and write functions.

© National Instruments 1483


Functions

By default, this function reads all characters from the text file. Wire an integer value to
count to specify how many individual characters you want to read starting with the
first character. Right-click the function and place a checkmark next to the Read Lines
option in the shortcut menu to read individual lines from the text file. When you select
the Read Lines option in the shortcut menu, wire an integer value to the count input to
specify how many individual lines you want to read from the file starting with the first
line. Enter a value of -1 in count to read all characters and lines from the text file.

Use the Set File Position function if you need to perform random access.

The function converts all platform-dependent end-of-line characters to line feed


characters unless you right-click the function and remove the checkmark next to the
Convert EOL shortcut menu item. If you wire a path to file, the function opens the file
before reading from it and closes it afterwards.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Text (ASCII)\Write to Text File


and Read from Text File.vi

Write to Binary File Function

Writes binary data to a new file, appends data to an existing file, or replaces the
contents of a file. This function does not work for files inside an LLB.

If you want to use the Read from Binary File function to read the array or string data
you write to file, the prepend array or string size? parameter must indicate TRUE.
Otherwise, LabVIEW generates an error.

This VI truncates arrays if the total array size is over 4 GB.

1484 ni.com
Functions

Inputs/Outputs
• prepend array or string size? (T) —

prepend array or string size? indicates whether LabVIEW includes data size information at the
beginning of the file when data is an array or string. If prepend array or string size? is FALSE,
LabVIEW does not include the size information.

The default is TRUE. prepend array or string size? controls only the top-level data size
information. Arrays and strings in hierarchical data types such as clusters always include size
information.

• prompt (Choose or enter file path) —

prompt is the message that appears above the list of files and directories, or folder, in the file
dialog box.

• file (use dialog) —

file can be a refnum or absolute file path.

If you wire a path to the file input, the function opens or creates the file before writing to it and
replaces any previous file contents. If you wire a file refnum to the file input, writing begins at
the current file position. To append to an existing file, set the file position to the end of the file by
using the Set File Position function. The default is to display a file dialog box and prompt you to
select a file.

If you specify an empty or relative path, this function returns an error.

• data —

data contains the data to write to the file and can be any data type.

• byte order (0:big-endian, network order) —

byte order sets the endian form of the resulting data. Byte order, or endian form, indicates
whether integers are represented in memory from most-significant byte to least-significant byte
or vice versa. The function must read the data in the same byte order that the data was written.

© National Instruments 1485


Functions

big-endian, network order (default)—The most-significant byte occupies the lowest memory
0 address. This endian form is used on PowerPC platforms such as VxWorks. This endian-form
also is used when reading data written on a different platform.
native, host order—Uses the byte-ordering format of the host computer. This endian form
1
increases read and write speed.
little-endian—The least-significant byte occupies the lowest memory address. This endian
2
form is used on Windows, macOS, and Linux.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• refnum out —

refnum out is the refnum of the file that the function read. You can wire this output to another
file function, depending on what you want to do with the file. The default is to close the file if it is
referenced by a file path or selected from the file dialog box. If file is a refnum or if you wire
refnum out to another function, LabVIEW assumes that the file is still in use until you close it.

• cancelled —

cancelled is TRUE if you cancel the file dialog box.

Otherwise, cancelled is FALSE, even if this function returns an error.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Deny Access function to make sure no other users change the file while you
write to it. Use the Set File Position function if you need to perform random access.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Binary\Simple Binary\Simple


Binary File.lvproj
• labview\examples\File IO\Spreadsheet\Tab-Delimited Data\

1486 ni.com
Functions

Buffered Stream to Tab-Delimited Text File.vi

Read from Binary File Function

Reads binary data from a file and returns it in data. How the data is read depends on
the format of the specified file. This function does not work for files inside an LLB.

Refer to the Preallocated Read from Binary File function for information about reading
binary data and placing it into a pre-allocated array without incurring a copy.

Inputs/Outputs
• data type —

data type sets the type of data the function uses to read from the binary file.

The function interprets the data starting at the current file position to be count instances of data
type. If the type is an array, string, or cluster containing an array or string, the function assumes
that each instance of that data type contains size information. If an instance does not include
size information, the function misinterprets the data. If LabVIEW determines that the data does
not match the type, it sets data to the default for the specified type and returns an error.

• prompt (Open existing file) —

prompt is the message that appears above the list of files and directories, or folder, in the file
dialog box.

• file (use dialog) —

file can be a refnum or absolute file path.

If it is a path, this function opens the file specified by the path. The default is to display a file
dialog box and prompt you to select a file.

If you specify an empty or relative path or if the file does not exist, this function returns an error.

© National Instruments 1487


Functions

• count (1) —

count is the number of data elements to read. Data elements can be bytes or instances of data
type.

The function returns count data elements in data, or if it reaches the end of the file, it returns all
the complete data elements read thus far and an end-of-file error. By default, the function
returns a single data element. If count is –1, the function reads the entire file starting from the
current file position. If count is less than –1, the function returns an error.

If you wire data to count and the specified data type is an array, the function automatically
returns a cluster of arrays or cluster array because LabVIEW does not allow arrays of arrays.

If you wire a file size with a data type other than a 32-bit integer to count, LabVIEW coerces the
data type to a 32-bit integer. This means the VI may not read the amount of data you intend. If
you wire –1 to count and the size of the file you want to read is too large to be represented by a
32-bit integer, LabVIEW returns an error.

If you wire a cluster of integers to count, the function returns a multidimensional array, one
dimension per each cluster element. For example, if you wire a cluster which contains the values
1, 2, and 3 to count, the function returns a 3D array, in which the first dimension contains one
element, the second dimension contains two elements, and the third dimension contains three
elements.

• byte order (0:big-endian, network order) —

byte order sets the endian form of the resulting data. Byte order, or endian form, indicates
whether integers are represented in memory from most-significant byte to least-significant byte
or vice versa. The function must read the data in the same byte order that the data was written.

big-endian, network order (default)—The most-significant byte occupies the lowest memory
0 address. This endian form is used on PowerPC platforms such as VxWorks. This endian-form
also is used when reading data written on a different platform.
native, host order—Uses the byte-ordering format of the host computer. This endian form
1
increases read and write speed.
little-endian—The least-significant byte occupies the lowest memory address. This endian
2
form is used on Windows, macOS, and Linux.

• error in —

error in describes error conditions that occur before this node runs. This input provides
standard error in functionality.

• refnum out —

1488 ni.com
Functions

refnum out is the refnum of the file that the function read. You can wire this output to another
file function, depending on what you want to do with the file. The default is to close the file if it is
referenced by a file path or selected from the file dialog box. If file is a refnum or if you wire
refnum out to another function, LabVIEW assumes that the file is still in use until you close it.

• data —

data contains the data read from the file in the specified data type. It can consist of a string, an
array, a cluster of arrays, or a cluster array, depending on which data type you are reading and
how count is set.

• cancelled —

cancelled is TRUE if you cancel the file dialog box.

Otherwise, cancelled is FALSE, even if this function returns an error.

• error out —

error out contains error information. This output provides standard error out functionality.

Use the Deny Access function to make sure no other users change the file while you
read from it. Use the Set File Position function if you need to perform random access.

This function opens files as read-only. If you wire the refnum out output of this
function to the file input of a write function, LabVIEW returns a permissions error. Use
the Open/Create/Replace File function to open the file with the default read/write
access and wire the refnum to the read and write functions.

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Datalog\Datalog File.lvproj


• labview\examples\File IO\Spreadsheet\Tab-Delimited Data\
Tab-Delimited Data.lvproj
• labview\examples\File IO\Binary\Simple Binary\Simple
Binary File.lvproj
• labview\examples\File IO\Binary\Endian Considerations\

© National Instruments 1489


Functions

Endian Considerations with Binary Files.vi

Build Path Function

Creates a new path by appending a name or a relative path to an existing path.

Inputs/Outputs
• base path —

base path specifies the path to which this function appends name or relative path.

The default is an empty path. If base path is invalid, this function sets appended path to <Not
A Path>.

• name or relative path —

name or relative path is the new path component appended to base path.

If name or relative path is an empty string or an invalid path, this function sets appended path
to <Not A Path>.

• appended path —

appended path is the resulting path.

Suppose you want to build the path c:\dir1\vis\first.vi. The following table
shows examples of how you can specify base path and name or relative path to build
this path.

Operation base path name or relative path


To specify a name c:\dir1\vis first.vi
To specify a relative path c:\dir1 vis\first.vi
To specify an absolute path — c:\dir1\vis\first.vi

1490 ni.com
Functions

Strip Path Function

Returns the name of the last component of a path and the stripped path that leads to
that component.

Inputs/Outputs
• path —

path specifies the path on which you want to operate.

If this parameter is an empty path or is invalid, this function returns an empty string in name and
<Not A Path> in stripped path.
• stripped path —

stripped path is the resulting path obtained by removing name from the end of path.

• name —

name is the last component of the specified path.

For the path C:\labview\foo.vi, stripped path returns C:\labview while


name returns foo.vi.

File Constants

Use the file constants with the File I/O VIs and functions.

Palette Object Description


Path Constant Use this constant to supply a constant path value to the block diagram.
Current VI's Returns the path to the file of the current VI. If the VI never has been saved, this
Path Function function returns <Not A Path>.

© National Instruments 1491


Functions

Palette Object Description

Get System
Returns the system directory specified in the system directory type input.
Directory

Empty Path
Returns an empty path.
Constant
Returns a path whose value is <Not A Path>. You can use this path as an output
Not A Path
from structures and subVIs when an error occurs and you do not want to return a
Constant
path.
Not a Refnum Returns a refnum whose value is Not A Refnum. You can use this refnum as an
Constant output from structures and subVIs when an error occurs.
Default
Directory Returns the path to the default directory.
Function

Default Data
Returns the directory you configure to store the data a VI or function generates.
Directory

VI Library Returns the path to the VI library directory for the current application instance on
Function the current computer.

Application
Returns the path to the directory containing the application.
Directory

Temporary
Directory Returns the path to the temporary directory.
Function

Path Constant

Use this constant to supply a constant path value to the block diagram.

Right-click the constant and select Browse for Path from the shortcut menu to
navigate to and select a path. You also can set the value of a path constant by using the
Operating tool or the Labeling tool to click it and enter the path you want. To enter the
path to a VI inside an LLB, add a backslash and the VI name to the end of the path to
the LLB. For example, C:\example.llb\color.vi. To enter the path of a VI from
a palette, place the VI on the block diagram and <Ctrl>-drag the VI into the path
constant.

1492 ni.com
Functions

You can resize a path constant.

You cannot change the value of the path constant while the VI runs. You can assign a
label to this constant.

Current VI's Path Function

Returns the path to the file of the current VI. If the VI never has been saved, this
function returns <Not A Path>.

This function always returns the current location of the VI. If you move the VI, the value
returned changes.

If you build the VI into an application, this function returns the path to the VI in the
application file, and treats the application file as a VI library.

Note To obtain the path to the directory containing the application, use the
Application Directory VI.

Inputs/Outputs
• path —

path is the path to the current VI.

Get System Directory

Returns the system directory specified in the system directory type input.

This VI returns the system directory of the current target, including My Computer.

© National Instruments 1493


Functions

(Real-Time Module) You cannot use this VI in VIs that run on RT targets.

Inputs/Outputs
• system directory type —

system directory type specifies the type of directory you want LabVIEW to retrieve.

User Home—Directory that contains the personal files of the current user. This directory is a
0
readable and writable directory accessible to a single user of the system.
User Desktop—Directory that contains files located on the desktop of the current user. This
1
directory is a readable and writable directory accessible to a single user of the system.
User Documents—Default directory for saving the documents of the current user. This
2
directory is a readable and writable directory accessible to a single user of the system.
User Application Data—Directory that contains data for the system applications of the current
3 user. This directory is a readable and writable directory accessible to a single user of the
system.
User Preferences—Directory that contains the preferences for the current user. This directory
4
is a readable and writable directory accessible to a single user of the system.
User Temporary—Directory that holds temporary files for the current user. This directory is a
5 readable and writable directory accessible to a single user of the system. You cannot change
the path to this temporary directory.
Public Documents—Directory that contains documents accessible to all users of the system.
6
This directory is readable and sometimes writable.
Public Application Data—Directory that contains data for system applications accessible to
7
all users of the system. This directory is readable and sometimes writable.
Public Preferences—Directory that contains preferences common to all users of the system.
8
This directory is readable and sometimes writable.
System Core Libraries—Directory that contains the libraries that come with the operating
9
system. This directory is typically read-only to the standard user of the system.
System Installed Libraries—Directory that contains libraries a user installs on the system.
10
This directory is typically read-only to the standard user of the system.
Application Files—Directory that contains files of applications installed on the system. This
11
directory is typically read-only to the standard user of the system.
Boot Volume Root—Top-level directory used to start the system. This directory is typically
12
read-only to the standard user of the system.
13 Public Cache—Directory that stores files the MathScript RT Module installs and shares among

1494 ni.com
Functions

all users for the purpose of making certain operations faster. This directory is readable and
sometimes writable.

• create directory if not found? (F) —

create directory if not found? specifies whether the VI creates a new directory if the specified
directory does not exist. If FALSE (default), the VI returns the path where the system expects to
find the directory. If TRUE, LabVIEW creates a new directory.

• system directory —

system directory returns the specified system directory of the current target.

If errors occur while accessing or creating a directory, or the current target does not
support the specified system directory type, the VI returns Not a Path.

Empty Path Constant

Returns an empty path.

Unlike the not a path constant, this constant is a valid path. You can use this constant
as a starting point for building paths using the Build Path function.

Not A Path Constant

Returns a path whose value is <Not A Path>. You can use this path as an output from
structures and subVIs when an error occurs and you do not want to return a path.

Unlike the empty path constant, this constant is an invalid path, and is generally
returned when a path operation fails.

© National Instruments 1495


Functions

Not a Refnum Constant

Returns a refnum whose value is Not A Refnum. You can use this refnum as an output
from structures and subVIs when an error occurs.

For example, you can use the Not a Refnum constant to verify that the refnum is valid
before passing the refnum to the next file I/O operation. Wire the error out cluster of a
file I/O function to the selector terminal of a Case structure. Place the Not a Refnum
constant in the Error subdiagram and wire the constant through the output tunnel
and to the next file I/O operation. In the No Error subdiagram, wire the refnum
output of the file I/O function through the Case structure and to the next file I/O
operation.

Note Do not test whether a refnum is invalid by comparing the refnum to the
output returned by the Not a Refnum constant. The Not a Refnum constant
returns a unique sequence of bits that is guaranteed to be an invalid refnum.
However, because this sequence of bits is only one possible invalid refnum
representation, it likely will not equal another refnum to which you compare
it. Instead, use the Not a Number/Path/Refnum? function to test whether a
refnum is invalid. The Not A Number/Path/Refnum? function returns a
Boolean value that is correct for all possible invalid refnum representations.

Default Directory Function

Returns the path to the default directory.

The default directory is the directory in which LabVIEW automatically stores


information unless you specify otherwise. You can view and set the path to the default
directory by selecting Default Directory from the pull-down menu on the Paths page of
the Options dialog box.

1496 ni.com
Functions

Inputs/Outputs
• path —

path is the path to the default directory.

Default Data Directory

Returns the directory you configure to store the data a VI or function generates.

You can set the default data directory in the Options dialog box.

Inputs/Outputs
• App:Default Data Directory —

App:Default Data Directory is the path to the default data directory.

VI Library Function

Returns the path to the VI library directory for the current application instance on the
current computer.

If you build the VI into an application, this function returns the path of the directory
containing the application file.

Inputs/Outputs
• path —

path is the path to the VI library directory for the current application instance on the current

© National Instruments 1497


Functions

computer.

Application Directory

Returns the path to the directory containing the application.

If you call this VI from a stand-alone application, this VI returns the path to the folder
containing the stand-alone application.

If you call this VI from the development environment and the VI is loaded in a LabVIEW
project file (.lvproj), this VI returns the path to the folder containing the project file.
If the project is not saved, this VI returns <Not a Path>.

If the top-level VI is not loaded in a project, the VI returns the path to the directory
containing the top level VI. If the VI is not saved to disk, this VI returns <Not a
Path>.

Inputs/Outputs
• Application Directory —

Application Directory is the path to the directory where this VI is running.

Temporary Directory Function

Returns the path to the temporary directory.

This temporary directory is the directory in which you want LabVIEW to store
information that you do not want to store in the default directory. You can set this
temporary directory in the Options dialog box. Setting this directory does not change
the system temporary directory.

1498 ni.com
Functions

Inputs/Outputs
• path —

path is the path to the temporary directory.

Configuration File VIs

Use the Configuration File VIs to create, modify, and read a platform-independent
configuration file.

Note Note

• You cannot include comments or any other information in a key string.


• You can use the Configuration File VIs for Windows configuration
settings files only in the ANSI format.

Palette
Description
Object

Open
Opens a reference to the configuration data found in a platform-independent
Config
configuration file.
Data

Reads a value associated with a key in a specified section from the configuration data
Read identified by refnum. If the key does not exist, the VI returns the default value. This VI
Key supports multibyte characters in strings. Wire data to the default value input to
determine the polymorphic instance to use or manually select the instance.

© National Instruments 1499


Functions

Palette
Description
Object

Writes a value to a key in a specified section of the configuration data identified by


Write refnum. This VI modifies data in memory. To write data to disk, use the Close Config Data
Key VI. Wire data to the value input to determine the polymorphic instance to use or manually
select the instance.

Remove
Removes a key in a specified section from the configuration data identified by refnum.
Key

Remove
Removes a section from the configuration data identified by refnum.
Section

Close
Writes data to the platform-independent configuration file identified by refnum and then
Config
closes the reference to that file.
Data

Get Key Gets the names of all keys in the specified section from the configuration data identified
Names by refnum.

Get
Section Gets the names of all sections from the configuration data identified by refnum.
Names
Not A
Config
Determines whether a configuration data refnum is valid.
Data
Refnum

Examples

Refer to the following example files included with LabVIEW.

• labview\examples\File IO\Configuration
(INI)\Configuration (INI) File.lvproj

1500 ni.com

You might also like