PXENV_UDP_CLOSE
[PXE UDP API]

UDP CLOSE. More...

Data Structures
struct	s_PXENV_UDP_CLOSE
	Parameter block for pxenv_udp_close(). More...
Defines
#define	PXENV_UDP_CLOSE   0x0031
	PXE API function code for pxenv_udp_close().
Typedefs
typedef struct s_PXENV_UDP_CLOSE	PXENV_UDP_CLOSE_t
Functions
PXENV_EXIT_t	pxenv_udp_close (struct s_PXENV_UDP_CLOSE *udp_close)
	UDP CLOSE.

---

Detailed Description

UDP CLOSE.

---

Define Documentation

#define PXENV_UDP_CLOSE   0x0031

PXE API function code for pxenv_udp_close().

Definition at line 763 of file pxe_api.h.

Referenced by pxe_api_call().

---

Typedef Documentation

typedef struct s_PXENV_UDP_CLOSE PXENV_UDP_CLOSE_t

Definition at line 770 of file pxe_api.h.

---

Function Documentation

PXENV_EXIT_t pxenv_udp_close

(

struct s_PXENV_UDP_CLOSE *

pxenv_udp_close

)

UDP CLOSE.

Parameters:

pxenv_udp_close

Pointer to a struct s_PXENV_UDP_CLOSE

Return values:

	PXENV_EXIT_SUCCESS	Always
	s_PXENV_UDP_CLOSE::Status	PXE status code

Exceptions:

None

-

Closes a UDP connection opened with pxenv_udp_open().

You can only have one open UDP connection at a time. You cannot have a UDP connection open at the same time as a TFTP connection. You cannot use pxenv_udp_close() to close a TFTP connection; use pxenv_tftp_close() instead.

On x86, you must set the s_PXE::StatusCallout field to a nonzero value before calling this function in protected mode. You cannot call this function with a 32-bit stack segment. (See the relevant implementation note for more details.)

Definition at line 205 of file pxe_udp.c.

References DBG, PXENV_EXIT_SUCCESS, PXENV_STATUS_SUCCESS, s_PXENV_UDP_CLOSE::Status, pxe_udp_connection::xfer, and xfer_close().

Referenced by pxe_api_call().

                                                                           {
        DBG ( "PXENV_UDP_CLOSE" );

        /* Close UDP connection */
        xfer_close ( &pxe_udp.xfer, 0 );

        pxenv_udp_close->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}