Task Methods
- Updated2023-02-21
- 4 minute(s) read
Task Methods
The Task type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddGlobalChannel | Adds a preconfigured, global channel to the task. |
| ConfigureLogging(String, TdmsLoggingOperation, LoggingMode) | Configures logging to a .tdms file when the acquisition starts.
|
| ConfigureLogging(String, TdmsLoggingOperation, LoggingMode, String) | Configures logging to a .tdms file when the acquisition starts with the specified TDMS channel group name.
|
| Control | Alters the state of the task according to the mode you specify. |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Dispose | Releases all resources used by Task. |
 | Dispose(Boolean) |
Releases the managed and unmanaged resources used by Task or optionally releases only the unmanaged resources.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnCounterOutput | Raises the CounterOutput event. |
| OnDigitalChangeDetection | Raises the DigitalChangeDetection event. |
| OnDone | Raises the Done event. |
| OnEveryNSamplesRead | Raises the EveryNSamplesRead event. |
| OnEveryNSamplesWritten | Raises the EveryNSamplesWritten event. |
| OnSampleClock | Raises the SampleClock event. |
| OnSampleComplete | Raises the SampleComplete event. |
| Start | Transitions the task to the running state, which begins the measurement or generation.
|
| StartNewFile | Starts a new TDMS file the next time data is written to disk.
|
| Stop | Transitions the task from the running to the committed state, which ends the measurement or generation.
|
| ToString | Returns a string representation of the object. (Overrides ObjectToString.) |
 | WaitForValidTimestamp(TimestampEvent) | Waits indefinitely until the specified timestampEvent has a value. |
| WaitForValidTimestamp(TimestampEvent, TimeSpan) | Waits until the specified timestampEvent has a value. |
| WaitUntilDone | Waits for the measurement or generation to complete, regardless of the amount of time needed, and returns if it has completed execution. |
| WaitUntilDone(Int32) | Waits for the measurement or generation to complete and returns if it has completed execution before the specified time elapses. |
| WaitUntilDone(TimeSpan) |
Waits for the measurement or generation to complete and returns if it has completed execution before the specified TimeSpan elapses. |