Table Of Contents

IviACPwr Get Next Coercion Record (G Dataflow)

Version:
    Last Modified: October 23, 2017

    Returns the coercion information associated with the IVI session.

    This node retrieves and clears the oldest instance in which the instrument driver coerced a value you specified to another value.

    If you set the Record Value Coercions property to TRUE, the instrument driver keeps a list of all coercions it makes on ViInt32 or ViReal64 values you pass to instrument driver nodes. You use this node to retrieve information from that list.

    If the next coercion record string, including the terminating NUL byte, contains more bytes than you indicate in this parameter, the node copies Buffer Size - 1 bytes into the buffer, places an ASCII NUL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the Buffer Size is 4, the node places "123" into the buffer and returns 7.

    If you pass a negative number, the node copies the value to the buffer regardless of the number of bytes in the value.

    If you pass 0, you can pass VI_NULL (0) for the coercion record input.

    The node returns an empty string in the coercion record input if no coercion records remain for the session.

    connector_pane_image
    datatype_icon

    instrument handle

    The instrument handle that you obtain from IviACPwr Initialize or IviACPwr Initialize With Options. The handle identifies a particular instrument session.

    Default: None

    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

    instrument handle out

    The instrument handle that you obtain from IviACPwr Initialize or IviACPwr Initialize With Options.

    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

    coercion record

    Returns the next coercion record for the IVI session.

    If there are no coercion records, the VI returns an empty string. The buffer must contain at least as many elements as the value you specify with the Buffer Size parameter. If the next coercion record string, including the terminating NUL byte, contains more bytes than you indicate with the Buffer Size parameter, the VI copies Buffer Size - 1 bytes into the buffer, places an ASCII NUL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the Buffer Size is 4, the VI places "123" into the buffer and returns 7.

    This control returns an empty string if no coercion records remain for the session.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Web Server: Not supported in VIs that run in a web application


    Recently Viewed Topics