cvs: phpdoc /en/reference/sockets/functions socket-set-option.xml

derek Wed Jan 21 22:45:54 2004 EDT Modified files: /phpdoc/en/reference/sockets/functions socket-set-option.xml Log: Adding Documentation http://cvs.php.net/diff.php/phpdoc/en/reference/sockets/functions/socket-set-option.xml?r1=1.4&r2=1.5&ty=u Index: phpdoc/en/reference/sockets/functions/socket-set-option.xml diff -u phpdoc/en/reference/sockets/functions/socket-set-option.xml:1.4 phpdoc/en/reference/sockets/functions/socket-set-option.xml:1.5 --- phpdoc/en/reference/sockets/functions/socket-set-option.xml:1.4 Tue Feb 4 20:53:06 2003 +++ phpdoc/en/reference/sockets/functions/socket-set-option.xml Wed Jan 21 22:45:54 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/sockets.xml, last change in rev 1.27 --> <refentry id="function.socket-set-option"> <refnamediv> @@ -17,7 +17,21 @@ </methodsynopsis> &warn.experimental.func; <para> - &warn.undocumented.func; + The <function>socket_set_option</function> function sets the option specified by the <parameter>optname</parameter> + parameter, at the protocol level specified by the <parameter>level</parameter> parameter, to the + value pointed to by the <parameter>optval</parameter> parameter for the socket + specified by the <parameter>socket</parameter> parameter. <function>socket_set_option</function> + will return &false; on failure. + </para> + <para> + The <parameter>level</parameter> parameter specifies the protocol level at + which the option resides. For example, to retrieve options at the socket level, + a <parameter>level</parameter> parameter of SOL_SOCKET would be used. Other + levels, such as TCP, can be used by specifying the protocol number of that level. + Protocol numbers can be found by using the <function>getprotobyname</function> function. + </para> + <para> + The available socket options are the same as those for the <function>socket_get_option</function> function. </para> <note> <para>