Efi_pxe_base_code.setstationip(), Setstationip(), Func – Intel Extensible Firmware Interface User Manual

Page 669

Advertising
background image

Protocols

— Network Support

Version 1.10

12/01/02

15-63

EFI_PXE_BASE_CODE.SetStationIp()

Summary

Updates the station IP address and/or subnet mask values of a network device.

Prototype

EFI_STATUS

(EFIAPI *EFI_PXE_BASE_CODE_SET_STATION_IP) (

IN

EFI_PXE_BASE_CODE

*This,

IN EFI_IP_ADDRESS

*NewStationIp, OPTIONAL

IN EFI_IP_ADDRESS

*NewSubnetMask OPTIONAL

);

Parameters

This

Pointer to the

EFI_PXE_BASE_CODE

instance.

NewStationIp

Pointer to the new IP address to be used by the network device. If this
field is

NULL

, then the

StationIp

address will not be modified.

NewSubnetMask

Pointer to the new subnet mask to be used by the network device. If this
field is

NULL

, then the

SubnetMask

will not be modified.

Description

This function updates the station IP address and/or subnet mask values of a network device.

The

NewStationIp

field is used to modify the network device’s current IP address. If

NewStationIP

is

NULL

, then the current IP address will not be modified. Otherwise, this

function updates the

StationIp

field of the

EFI_PXE_BASE_CODE_MODE

structure with

NewStationIp

.

The

NewSubnetMask

field is used to modify the network device’s current subnet mask. If

NewSubnetMask

is

NULL

, then the current subnet mask will not be modified. Otherwise, this

function updates the

SubnetMask

field of the

EFI_PXE_BASE_CODE_MODE

structure with

NewSubnetMask

.

Status Codes Returned

EFI_SUCCESS

The new station IP address and/or subnet mask were updated.

EFI_INVALID_PARAMETER

One of the parameters is not valid.

EFI_NOT_STARTED

The PXE Base Code Protocol is not in the started state.

Advertising