Getboard.vi – Measurement Computing UL for NI LabVIEW User Manual

Page 97

Advertising
background image

Universal Library Virtual Instruments (VIs)

Miscellaneous VIs

GetBoard.VI

Returns the board name of a specified board.

Summary:

Input:

BoardNum

[U32] - The board number assigned when installed with InstaCal. Can

be 0 to 100, or

GETFIRST

or

GETNEXT

Outputs:

BoardName

[abc] - Name of the specified board.

ErrCode

[I32] - Error code. See ErrMsg.VI

Arguments:

BoardNum

The board number associated with a board when it was installed with InstaCal, or

GETFIRST

or

GETNEXT

.

BoardName

A string variable that the board name will be returned to. This string variable must

be pre-allocated to be at least as large as

BOARDNAMELEN

. This size is guaranteed to

be large enough to hold the longest board name string.

ErrCode

Error code from the Universal Library. Zero if no error occurred. Use the ErrMsg

VI to convert

ErrCode

into a readable string.

Notes:

There are two distinct ways of using this function:

ƒ Pass a board number as the

BoardNum

argument. In that case the string that is returned will describe the

board type of the installed board.

ƒ Set

BoardNum

to

GETFIRST

(-2) or

GETNEXT

(-3), to get a list of all board types that are supported by the

library. If

BoardNum

is set to

GETFIRST,

it will return the first board type in the list of supported boards.

Subsequent calls with

BoardNum=GETNEXT

will return each of the other board types supported by the

library. When you reach the end of the list

BoardName

will be set to an empty string.

97

Advertising