NI FGEN Configure Peer to Peer Functions

Configure P2P Functions

• niFgen_ManualEnableP2PStream
• niFgen_WriteP2PEndpointI16
• niFgen_GetStreamEndpointHandle

niFgen_ManualEnableP2PStream

ViStatus niFgen_ManualEnableP2PStream (ViSession vi, ViConstString endpointName[]

Purpose

Enables a peer-to-peer data stream using manual flow control.

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.
endpointName	ViConstString []	Specifies the stream endpoint FIFO to configure. Refer to the Peer-to-Peer Data Streaming documentation in the NI Signal Generators Help for more information.

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:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niFgen_WriteP2PEndpointI16

ViStatus niFgen_WriteP2PEndpointI16 (ViSession vi, ViConstString endpointName, ViInt32 numberOfSamples, ViInt16 endpointData[])

Purpose

Writes I16 data to the peer-to-peer endpoint. Use this function to write initial data from the host to the endpoint before starting generation to avoid an underflow at start.

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.
endpointName	ViConstString []	Specifies the name of the FIFO endpoint. Data is written to the endpoint FIFO.
numberOfSamples	ViInt32	Specifies the number of samples to write into the endpoint FIFO.
endpointData	ViInt16 []	Specifies the array of data to write into the endpoint FIFO. The binary data is left-justified.

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:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors

niFgen_GetStreamEndpointHandle

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:

Value	Meaning
0	Success
Positive Values	Warnings
Negative Values	Errors