Table Of Contents

Lock (G Dataflow)

Version:
    Last Modified: March 3, 2017

    A deprecated function that attempts to establish access to the device or interface.

    Depending on the overload you select, this function corresponds to the following LabVIEW NXG functions:

    Overload Redirects To
    Lock (GPIB Interface).gvi
    • Lock (GPIB Interface, Exclusive).gvi
    • Lock (GPIB Interface, Shared).gvi
    Lock (Instr).gvi
    • Lock (Instr, Exclusive).gvi
    • Lock (Instr, Shared).gvi
    Lock (PXI Backplane).gvi
    • Lock (PXI Backplane, Exclusive).gvi
    • Lock (PXI Backplane, Shared).gvi
    Lock (PXI MemAcc).gvi
    • Lock (PXI MemAcc, Exclusive).gvi
    • Lock (PXI MemAcc, Shared).gvi
    Lock (VXI Backplane).gvi
    • Lock (VXI Backplane, Exclusive).gvi
    • Lock (VXI Backplane, Shared).gvi
    Lock (VXI MemAcc).gvi
    • Lock (VXI MemAcc, Exclusive).gvi
    • Lock (VXI MemAcc, Shared).gvi
    connector_pane_image
    datatype_icon

    session in

    The resource to be used.

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    lock type

    The type of lock to request for the session.

    If a session has an exclusive lock, other sessions cannot modify global attributes or invoke operations, but still can get attributes and set local attributes. If the session has a shared lock, other sessions that have shared locks also can modify global attributes and invoke operations.

    Value Lock Type
    1 Exclusive
    2 Shared

    Default: 1

    datatype_icon

    requested key

    Unique access key for the shared lock.

    datatype_icon

    lock timeout

    Maximum time period, in milliseconds, that the function waits for access to lock.

    datatype_icon

    session out

    The resource to which a VISA session is opened.

    This output also includes the class for the session, which matches that of session in.

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
    datatype_icon

    access key

    A unique access key for the lock.

    After the function runs, you can share the lock with other sessions of the same resource by wiring this parameter as the requested key to subsequent Lock (Shared) operations.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported


    Recently Viewed Topics