]> git.proxmox.com Git - mirror_edk2.git/blobdiff - StdLib/BsdSocketLib/getsockopt.c
MdeModulePkg: Add DriverHealthManagerDxe driver.
[mirror_edk2.git] / StdLib / BsdSocketLib / getsockopt.c
index eac10544de15ed3675c84f6730cb6c902ae88356..8a77570cc5cd1ef914122e529e2280ea45c35090 100644 (file)
@@ -1,22 +1,23 @@
 /** @file\r
   Implement the getsockopt API.\r
 \r
-  Copyright (c) 2011, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
+  Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials are licensed and made available under\r
+  the terms and conditions of the BSD License that accompanies this distribution.\r
+  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
 **/\r
-\r
 #include <SocketInternals.h>\r
 \r
 \r
-/**\r
-  Get the socket options\r
+/** Get the socket options\r
+\r
+  The\r
+  <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockopt.html#">POSIX</a>\r
+  documentation is available online.\r
 \r
   @param [in] s               Socket file descriptor returned from ::socket.\r
   @param [in] level           Option protocol level\r
@@ -25,9 +26,8 @@
   @param [in,out] option_len  Length of the buffer in bytes,\r
                               upon return length of the option value in bytes\r
 \r
-  @retval   Zero (0) upon success\r
-  @retval   Minus one (-1) upon failure, errno set with additional error information\r
-\r
+  @return     This routine returns zero (0) if successful or -1 when an error occurs.\r
+              In the case of an error, ::errno contains more details.\r
 **/\r
 int\r
 getsockopt (\r
@@ -40,27 +40,19 @@ getsockopt (
 {\r
   int OptionStatus;\r
   EFI_SOCKET_PROTOCOL * pSocketProtocol;\r
-  EFI_STATUS Status;\r
-  \r
-  //\r
+\r
   //  Locate the context for this socket\r
-  //\r
   pSocketProtocol = BslFdToSocketProtocol ( s, NULL, &errno );\r
   if ( NULL != pSocketProtocol ) {\r
-    //\r
     //  Get the socket option\r
-    //\r
-    Status = pSocketProtocol->pfnOptionGet ( pSocketProtocol,\r
+    (void) pSocketProtocol->pfnOptionGet ( pSocketProtocol,\r
                                              level,\r
                                              option_name,\r
                                              option_value,\r
                                              option_len,\r
                                              &errno );\r
   }\r
-  \r
-  //\r
   //  Return the operation stauts\r
-  //\r
   OptionStatus = ( 0 == errno ) ? 0 : -1;\r
   return OptionStatus;\r
 }\r