NI-HSDIO C Function Reference

niHSDIO_ConfigurePatternMatchAdvanceTrigger

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

ViStatus = niHSDIO_ConfigurePatternMatchAdvanceTrigger ( ViSession vi, ViConstString channelList, ViConstString pattern, ViInt32 triggerWhen);

Purpose

Configures the Advance trigger for pattern-match triggering. This function is valid only for acquisition operations.

Valid Syntax:

Both of the following examples are valid and do the same thing. The order of channelList determines the order of the pattern string.

  • niHSDIO_ConfigurePatternMatchAdvanceTrigger (vi, "19-0", "0000 0XXX XX11 1111 1111");
  • niHSDIO_ConfigurePatternMatchAdvanceTrigger (vi, "0-19", "1111 1111 11XX XXX0 0000");
Note  The logic levels seen by pattern matching are affected by data interpretation.

Related topics:

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function.
Channel List ViConstString This string specifies which channels are configured for pattern matching using the pattern string. The order of channels in the list determines the order of the pattern string.
Pattern ViConstString This string expression describes the pattern to be matched. This expression is composed of the following characters:
  • X or x: Ignore the channel
  • 1: Match on a logic 1
  • 0: Match on a logic 0
  • R or r: Match on a rising edge
  • F or f: Match on a falling edge
  • E or e: Match on either edge

The first character in the expression corresponds to the first channel in channelList. The number of characters in pattern must correspond to the number of channels specified in channelList.

Trigger When ViInt32 Specifies when the trigger asserts.

Defined Values

NIHSDIO_VAL_PATTERN_MATCHES (36)—The trigger asserts when the pattern matches.
NIHSDIO_VAL_PATTERN_DOES_NOT_MATCH (37)—The trigger asserts when the pattern does not match.

Return Value

Name Type Description
Status ViStatus

Reports the status of this operation. To obtain a text description of the status code, call the niHSDIO_error_message function. To obtain additional information concerning the error condition, use the niHSDIO_GetError and niHSDIO_ClearError functions.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience