View source for System.Net.Socket.TSocket.OpenBroadcast

{{#lst:API:System.Net.Socket.TSocket.OpenBroadcast|api}}
==Description==
{{#ifeq: {{PAGENAME}}|System.Net.Socket.TSocket.OpenBroadcast||{{InheritsFrom|System.Net.Socket.TSocket.OpenBroadcast}}}}

<section begin=short />Configures your socket to send local sub-net broadcasts to the specified port or [[System.Net.Socket.TNetEndpoint|endpoint]].<section end=short />

In order to use [[System.Net.Socket.TSocket.OpenBroadcast|OpenBroadcast]], the [[System.Net.Socket.TSocket.SocketType|type of your socket]] must be {{Const|UDP}}.

=== Exceptions ===

A call to [[System.Net.Socket.TSocket.OpenBroadcast|OpenBroadcast]] can raise any of the following exceptions:

{| class="wikitable"
! [[System.SysUtils.Exception|Exception]]
! [[System.SysUtils.Exception.Message|Exception.Message]]
! Scenarios
|- valign="top"
| rowspan="4" |
[[System.Net.Socket.ESocketError|ESocketError]]
|
Network socket error: {{Placeholder|error message}} ({{Placeholder|error code}}), on API 'setsockopt'
|
* The operating system reported an error while configuring your socket to send broadcast data. For more information, see the following documentation for the operating system where your application was running:
** Windows: [https://msdn.microsoft.com/en-us/library/windows/desktop/ms740476 setsockopt function (MSDN)]
** Mac OS X: [https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man2/setsockopt.2.html setsockopt (OS X Man Pages)]
** iOS: [https://developer.apple.com/library/ios/documentation/System/Conceptual/ManPages_iPhoneOS/man2/setsockopt.2.html setsockopt (iOS Manual Pages)]
** Android: [http://man7.org/linux/man-pages/man2/setsockopt.2.html#ERRORS setsockopt (Linux Programmer's Manual)]
|- valign="top"
|
Network socket error: {{Placeholder|error message}} ({{Placeholder|error code}}), on API 'socket'
|
* The operating system reported an error while creating a socket. For more information, see the following documentation for the operating system where your application was running:
** Windows: [https://msdn.microsoft.com/en-us/library/windows/desktop/ms740506 socket function (MSDN)]
** Mac OS X: [https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man2/socket.2.html socket (OS X Man Pages)]
** iOS: [https://developer.apple.com/library/ios/documentation/System/Conceptual/ManPages_iPhoneOS/man2/socket.2.html socket (iOS Manual Pages)]
** Android: [http://man7.org/linux/man-pages/man2/socket.2.html#ERRORS socket (Linux Programmer's Manual)]
|- valign="top"
|
Only UDP socket types support broadcasts
|
* The [[System.Net.Socket.TSocket.SocketType|type of your socket]] is not {{Const|UDP}}. Only UDP sockets support broadcasts.
|- valign="top"
|
Socket already open
|
* You cannot open a socket that is already open. A previous call to any of the following methods must have opened the socket already:
** [[System.Net.Socket.TSocket.Bind|Bind]]
** [[System.Net.Socket.TSocket.Connect|Connect]]
** [[System.Net.Socket.TSocket.Create|Create]] (if you specify a socket handle and a socket address)
** [[System.Net.Socket.TSocket.GetClientSocket|GetClientSocket]]
** [[System.Net.Socket.TSocket.Listen|Listen]]
** [[System.Net.Socket.TSocket.ListenBroadcast|ListenBroadcast]]
** [[System.Net.Socket.TSocket.OpenBroadcast|OpenBroadcast]]
|}

=== See Also ===

* [[System.Net.Socket.TSocket.SocketType]]
* [[System.Net.Socket.TNetEndpoint]]

* [[System.Net.Socket.TSocket.ListenBroadcast]]

* [[System.Net.Socket.TSocket.CreateSocket]]


[[Category:API Documentation]]
[[Category:XE8]]