niFgen_GetStreamEndpointHandle
- Updated2023-02-21
- 1 minute(s) read
ViStatus niFgen_GetStreamEndpointHandle (ViSession vi, ViConstString streamEndpoint, ViInt32* readerHandle);
Purpose
Returns a reader endpoint handle that can be used with NI-P2P to configure a peer-to-peer stream with a signal generator endpoint.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init, niFgen_InitWithOptions, or niFgen_InitializeWithChannels functions and identifies a particular instrument session. |
| streamEndpoint | ViConstString | Specifies the stream endpoint FIFO to configure. Refer to the device-specific documentation for peer-to-peer streaming in the NI Signal Generators Help for more information. |
| Output | ||
| Name | Type | Description |
| readerHandle | ViInt32* | Specifies the reader endpoint handle that is used with NI-P2P to create a stream with the signal generator as an endpoint. |
Return Value
| Name | Type | Description | ||||||||
| status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|