PowerShellUDPModule.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-UdpListener --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-UdpListener</command:name> <command:verb>Get</command:verb> <command:noun>UdpListener</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-UdpListener</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: UdpClient --> <command:returnValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: New-UdpListener --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-UdpListener</command:name> <command:verb>New</command:verb> <command:noun>UdpListener</command:noun> <maml:description> <maml:para>Creates a new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>objects are used to listen for client requests.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-UdpListener</maml:name> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port to listen on.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Port --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port to listen on.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: UdpClient --> <command:returnValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Stop-UdpListener --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-UdpListener</command:name> <command:verb>Stop</command:verb> <command:noun>UdpListener</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Stop-UdpListener</maml:name> <!-- Parameter: Listener --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Listener</maml:name> <maml:description> <maml:para>Used to listen for client requests.</maml:para> </maml:description> <command:parameterValue required="true">UdpClient</command:parameterValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Listener --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Listener</maml:name> <maml:description> <maml:para>Used to listen for client requests.</maml:para> </maml:description> <command:parameterValue required="true">UdpClient</command:parameterValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Used to listen for client requests.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Send-UdpRequest --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-UdpRequest</command:name> <command:verb>Send</command:verb> <command:noun>UdpRequest</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter set: Port-Byte --> <command:syntaxItem> <maml:name>Send-UdpRequest</maml:name> <!-- Parameter: ServerPort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Port"> <maml:name>ServerPort</maml:name> <maml:description> <maml:para>The port to send datagram to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: RawDatagram --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RawData,RawBody,RawContent"> <maml:name>RawDatagram</maml:name> <maml:description> <maml:para>The raw data to send.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Port-UTF8 --> <command:syntaxItem> <maml:name>Send-UdpRequest</maml:name> <!-- Parameter: ServerPort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Port"> <maml:name>ServerPort</maml:name> <maml:description> <maml:para>The port to send datagram to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: UTF8Datagram --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Datagram,Data,Body,Content"> <maml:name>UTF8Datagram</maml:name> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IPEndPoint-Byte --> <command:syntaxItem> <maml:name>Send-UdpRequest</maml:name> <!-- Parameter: ServerIpEndPoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerIpEndPoint</maml:name> <maml:description> <maml:para>An IPEndPoint specifying the server to send to. Default: IPEndPoint(IpAddress.Broadcast, 11000) # sends datagrams for broadcast on 11000.</maml:para> </maml:description> <command:parameterValue required="true">IPEndPoint</command:parameterValue> <dev:type> <maml:name>System.Net.IPEndPoint</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RawDatagram --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RawData,RawBody,RawContent"> <maml:name>RawDatagram</maml:name> <maml:description> <maml:para>The raw data to send.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: IPEndPoint-UTF8 --> <command:syntaxItem> <maml:name>Send-UdpRequest</maml:name> <!-- Parameter: ServerIpEndPoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerIpEndPoint</maml:name> <maml:description> <maml:para>An IPEndPoint specifying the server to send to. Default: IPEndPoint(IpAddress.Broadcast, 11000) # sends datagrams for broadcast on 11000.</maml:para> </maml:description> <command:parameterValue required="true">IPEndPoint</command:parameterValue> <dev:type> <maml:name>System.Net.IPEndPoint</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UTF8Datagram --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Datagram,Data,Body,Content"> <maml:name>UTF8Datagram</maml:name> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ServerPort --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Port"> <maml:name>ServerPort</maml:name> <maml:description> <maml:para>The port to send datagram to.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="0" aliases="Port"> <maml:name>Port</maml:name> <maml:description> <maml:para>The port to send datagram to.</maml:para> <maml:para>This is an alias of the ServerPort parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ServerIpEndPoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ServerIpEndPoint</maml:name> <maml:description> <maml:para>An IPEndPoint specifying the server to send to. Default: IPEndPoint(IpAddress.Broadcast, 11000) # sends datagrams for broadcast on 11000.</maml:para> </maml:description> <command:parameterValue required="true">IPEndPoint</command:parameterValue> <dev:type> <maml:name>System.Net.IPEndPoint</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RawDatagram --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RawData,RawBody,RawContent"> <maml:name>RawDatagram</maml:name> <maml:description> <maml:para>The raw data to send.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RawData,RawBody,RawContent"> <maml:name>RawData</maml:name> <maml:description> <maml:para>The raw data to send.</maml:para> <maml:para>This is an alias of the RawDatagram parameter.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RawData,RawBody,RawContent"> <maml:name>RawBody</maml:name> <maml:description> <maml:para>The raw data to send.</maml:para> <maml:para>This is an alias of the RawDatagram parameter.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="RawData,RawBody,RawContent"> <maml:name>RawContent</maml:name> <maml:description> <maml:para>The raw data to send.</maml:para> <maml:para>This is an alias of the RawDatagram parameter.</maml:para> </maml:description> <command:parameterValue required="true">byte[]</command:parameterValue> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UTF8Datagram --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Datagram,Data,Body,Content"> <maml:name>UTF8Datagram</maml:name> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Datagram,Data,Body,Content"> <maml:name>Datagram</maml:name> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> <maml:para>This is an alias of the UTF8Datagram parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Datagram,Data,Body,Content"> <maml:name>Data</maml:name> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> <maml:para>This is an alias of the UTF8Datagram parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Datagram,Data,Body,Content"> <maml:name>Body</maml:name> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> <maml:para>This is an alias of the UTF8Datagram parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Datagram,Data,Body,Content"> <maml:name>Content</maml:name> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> <maml:para>This is an alias of the UTF8Datagram parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Byte[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The raw data to send.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The data to send (in UTF8).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: UdpClient --> <command:returnValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Wait-UdpRequest --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Wait-UdpRequest</command:name> <command:verb>Wait</command:verb> <command:noun>UdpRequest</command:noun> <maml:description> <maml:para>Creates a new object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>objects are used to listen for client requests.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Infinite --> <command:syntaxItem> <maml:name>Wait-UdpRequest</maml:name> <!-- Parameter: InfiniteRequests --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Infinity"> <maml:name>InfiniteRequests</maml:name> <maml:description> <maml:para>Never stop the listener loop.</maml:para> <maml:para>WARNING: be careful of how you are using this because it results in an infinite blocking loop.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Listener --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Listener</maml:name> <maml:description> <maml:para>Used to listen for client requests.</maml:para> </maml:description> <command:parameterValue required="true">UdpClient</command:parameterValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Limited --> <command:syntaxItem> <maml:name>Wait-UdpRequest</maml:name> <!-- Parameter: Listener --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Listener</maml:name> <maml:description> <maml:para>Used to listen for client requests.</maml:para> </maml:description> <command:parameterValue required="true">UdpClient</command:parameterValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfRequests --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Count"> <maml:name>NumberOfRequests</maml:name> <maml:description> <maml:para>Number of requests to listen for before exiting the listener loop.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Listener --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Listener</maml:name> <maml:description> <maml:para>Used to listen for client requests.</maml:para> </maml:description> <command:parameterValue required="true">UdpClient</command:parameterValue> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfRequests --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Count"> <maml:name>NumberOfRequests</maml:name> <maml:description> <maml:para>Number of requests to listen for before exiting the listener loop.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Count"> <maml:name>Count</maml:name> <maml:description> <maml:para>Number of requests to listen for before exiting the listener loop.</maml:para> <maml:para>This is an alias of the NumberOfRequests parameter.</maml:para> </maml:description> <command:parameterValue required="true">long</command:parameterValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: InfiniteRequests --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Infinity"> <maml:name>InfiniteRequests</maml:name> <maml:description> <maml:para>Never stop the listener loop.</maml:para> <maml:para>WARNING: be careful of how you are using this because it results in an infinite blocking loop.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases="Infinity"> <maml:name>Infinity</maml:name> <maml:description> <maml:para>Never stop the listener loop.</maml:para> <maml:para>WARNING: be careful of how you are using this because it results in an infinite blocking loop.</maml:para> <maml:para>This is an alias of the InfiniteRequests parameter.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Net.Sockets.UdpClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Used to listen for client requests.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: UdpRequest --> <command:returnValue> <dev:type> <maml:name>PowerShell.UDP.UdpRequest</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> </helpItems> |