NI Bluetooth Analysis Toolkit

niBT SA Open Session VI

  • Updated2023-02-21
  • 3 minute(s) read

Looks up an existing niBT SA session using the session name parameter and returns the refnum that you can pass to subsequent niBT SA VIs and the niBT SA Configure Analysis Property Node. If the look up fails, the niBT SA Open Session VI creates a new niBT SA session and returns a new refnum.

niBT SA Open Session

cstr.gif

session name specifies the name of the session that you are looking up or creating. If a session with the same name already exists, this VI returns a reference to that session. To get the reference to an already-opened session x, specify x as the session name.

You can obtain the reference to an existing session multiple times if you have not called the niBT SA Close Session VI in that session. You do not need to close the session multiple times. To create an unnamed session, pass an empty string to the session name parameter or leave this parameter unwired.

Tip  National Instruments recommends that you call the niBT SA Close Session VI for each unique named instance of the niBT SA Open Session VI or each instance of the niBT SA Open Session VI with an unnamed session.
ci32.gif

toolkit compatibility version specifies the version of the toolkit to which the current version of the toolkit is compatible. If the behavior of the toolkit changes in a new version, use this parameter to specify that you want to continue using the behavior of the previous release.

1.0.0 (10000)

Specifies that the current version of the toolkit is compatible with 1.0.0.

cerrcodeclst.gif

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

irn.gif

niBT SA session out returns the niBT SA session refnum. Use this reference as the session input to subsequent VIs.

Note  Close the niBT SA session refnum using the niBT SA Close Session VI before the VI completes execution to avoid possible memory leak issues.
ibool.gif

new session? indicates whether the VI creates a new session.

TRUE Indicates that the VI creates a new session.
FALSE Indicates that the VI returns a reference to an existing session.
ierrcodeclst.gif

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

Log in to get a better experience