IUDPChannelStreamSession.DeployUDPChannelStreamSession Method

Download PDF

Updated2023-02-21
3 minute(s) read

Deploys the UDP Channel Stream session. The VeriStand Gateway publishes the channels specified by this session to a UDP multicast address.

Namespace: NationalInstruments.VeriStand.ClientAPI
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)

Visual Basic (Declaration)
Function DeployUDPChannelStreamSession ( _ <OutAttribute> ByRef address As String, _ <OutAttribute> ByRef port As UShort, _ <OutAttribute> ByRef max_packet_size As Integer, _ <OutAttribute> ByRef channel_ids As Integer(), _ <OutAttribute> ByRef packet_ids As Integer() _ ) As Error

Visual Basic (Declaration)

Function DeployUDPChannelStreamSession ( _
	<OutAttribute> ByRef address As String, _
	<OutAttribute> ByRef port As UShort, _
	<OutAttribute> ByRef max_packet_size As Integer, _
	<OutAttribute> ByRef channel_ids As Integer(), _
	<OutAttribute> ByRef packet_ids As Integer() _
) As Error

C#
Error DeployUDPChannelStreamSession( out string address, out ushort port, out int max_packet_size, out int[] channel_ids, out int[] packet_ids )

Visual C++
Error^ DeployUDPChannelStreamSession( [OutAttribute] String^% address, [OutAttribute] unsigned short% port, [OutAttribute] int% max_packet_size, [OutAttribute] array<int>^% channel_ids, [OutAttribute] array<int>^% packet_ids )

Visual C++

Error^ DeployUDPChannelStreamSession(
	[OutAttribute] String^% address, 
	[OutAttribute] unsigned short% port, 
	[OutAttribute] int% max_packet_size, 
	[OutAttribute] array<int>^% channel_ids, 
	[OutAttribute] array<int>^% packet_ids
)

Parameters

address: Type: System.String %
The multicast address to which the VeriStand Gateway publishes the data.

port: Type: System.UInt16 %
The multicast address port to which the VeriStand Gateway publishes the data.

max_packet_size: Type: System.Int32 %
The maximum UDP packet size, in bytes, that the VeriStand Gateway successfully published.

channel_ids: Type: System.Int32 %
The channel IDs for each channel in the session. Each UDP packet contains a list of channel IDs that it uses to look up channel data.

packet_ids: Type: System.Int32 %
The packet IDs. The VeriStand Gateway might publish one or more packets corresponding to this stream session.

Return Value

Returns an Error object. If no error occurs, the Code property of the Error object is 0.

VeriStand .NET API Reference

Table of Contents

IUDPChannelStreamSession.DeployUDPChannelStreamSession Method

Parameters

Return Value

See Also

Reference