MessageRegexProxyOut Class
(Automation::MessageRegexProxyOut)The MessageRegexProxyOut is a conditional output argument for MessageRegexProxy. More...
| Header: | #include <MessageRegexProxyOut.h> |
| Inherits: | MessageArgument |
Public Functions
| MessageRegexProxyOut(std::function<int( const MessageArgument & arg, void * message ) > handler) | |
| bool | Matches(const std::string &string) |
- 19 public functions inherited from MessageArgument
- 46 public functions inherited from CDPBaseObject
- 26 public functions inherited from CDP::StudioAPI::CDPNode
- 22 public functions inherited from CDP::StudioAPI::ICDPNode
Additional Inherited Members
- 1 static public member inherited from CDPBaseObject
- 1 protected function inherited from CDP::StudioAPI::CDPNode
- 11 protected variables inherited from CDPBaseObject
Detailed Description
The MessageRegexProxyOut is a conditional output argument for MessageRegexProxy.
The MessageRegexProxyOut argument has the following additional properties (in addition to MessageArgument):
| Property | Description |
|---|---|
| Search | POSIX regular expression search pattern to match for the send. |
Below is a table with the most useful special characters in patterns:
| (...) | Specifies a block (regex group). Anything that is matched inside parenthesis can be references using $1 $2 etc in the Replace field. |
| . | Matches any character |
| \. | Matches . character (dot) |
| \s | Matches any whitespace character (space, tab or newline) |
| \S | Matches any non-whitespace character (any character except space, tab and newline) |
| \d | Matches any digit character |
| \D | Matches any non-digit character |
| \w | Matches any alphanumeric character (letter, number or underscore) |
| \W | Matches any non-letter character (so it is not a letter, number nor underscore) |
| + | Indicates one or more occurrences of the preceding elements. For example, S+ causes to match one or more sequential non-whitespace characters. |
| * | Indicates zero or more occurrences of the preceding elements. For example, S* causes to match any number (or zero) sequential non-whitespace characters. |
You can learn more about regex expression possibilities, at:
See also MessageRegexProxy and MessageArgument.
Member Function Documentation
MessageRegexProxyOut::MessageRegexProxyOut(std::function<int( const MessageArgument & arg, void * message ) > handler)
Default constructs an instance of MessageRegexProxyOut.
bool MessageRegexProxyOut::Matches(const std::string &string)
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.