Table Of Contents

Discard Events (G Dataflow)

Version:
    Last Modified: March 3, 2017

    Discards all pending occurrences of a specific event type from the session's event queue.

    This function discards information about all the event occurrences that have not yet been handled. This behavior is useful if you want to remove event occurrences that an operation no longer needs. Discarded event occurrences are not available to a session at a later time.

    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

    event type

    The logical event identifier.

    spd-note-note
    Note  

    All Enabled is not a valid input for this parameter.

    Name Value Description
    Service Request 3FFF200B A service request is received from the device or interface associated with the given session.
    spd-note-note
    Note  

    When you receive this event on an instrument session, you must call Read STB to guarantee delivery of future service request events on the given session.

    Trigger BFFF200A A trigger interrupt is received from the device. This may be either a hardware or software trigger, depending on the interface and the current session settings.
    PXI Interrupt 3FFF2022 A PXI interrupt occurs.
    Serial Break 3FFF2023 A break signal is received.
    Serial TermChar 3FFF2024 The termination character is received. You can specify the actual termination character by selecting Message Based Settings»Termination Character from VISA Properties.
    Serial CTS 3FFF2029 The Clear to Send (CTS) line changes state. If the CTS line changes state quickly several times in succession, not all line state changes necessarily result in event notifications.
    Serial DSR 3FFF202A The Data Set Ready (DSR) line changes state. If the DSR line changes state quickly several times in succession, not all line state changes necessarily result in event notifications.
    Serial DCD 3FFF202C The Data Carrier Detect (DCD) line changes state. If the DCD line changes state quickly several times in succession, not all line state changes necessarily result in event notifications.
    Serial RI 3FFF202E The Ring Indicator (RI) input signal is asserted.
    Serial Character 3FFF2035 At least one data byte is received. Each data character does not necessarily result in an event notification. In other words, if multiple data bytes arrive at once, you may get only one event.
    USB Interrupt 3FFF2037 A USB interrupt occurs.
    VXI Signal 3FFF2020 A VXIbus signal or VXIbus interrupt is received from the device associated with the given session.
    VXI/VME Interrupt BFFF2021 A VXIbus interrupt is received from the device associated with the given session.

    Default: Service Request

    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.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported


    Recently Viewed Topics