Interface a Trigger Pipe.
More...
Interface a Trigger Pipe.
A RunnerPipe is usually implemented as composition tree with the root item can be obtained by GetFirstItem. To create a pipe see adtf::streaming::ant::create_trigger_pipe .
- See also
- create_trigger_pipe
Definition at line 117 of file triggerpipe_intf.h.
◆ Close()
virtual tResult Close |
( |
| ) |
|
|
pure virtual |
Close and unregister every pipe item from its ITriggerPipeSource.
- Returns
- Standard Result Code.
◆ GetFirstItem()
Retrieves the first source item of the defined Trigger Pipe.
- Parameters
-
[in,out] | pSubRu | Object Reference to retrieve the first pipe source item. |
- Returns
- Standard Result Code.
- Return values
-
ERR_NOT_INITIALIZED | The first item is not set and the Trigger Pipe is empty. |
◆ GetName()
Gets the name of the Pipe.
- Parameters
-
[out] | strName | name returned |
- Returns
- The result of the IString::Set call.
◆ Open()