Share via


InitializeIpInterfaceEntry (Compact 2013)

3/26/2014

This function initializes the members of an MIB_IPINTERFACE_ROW entry with default values.

Syntax

NETIOAPI_API InitializeIpInterfaceEntry(
  __inout  PMIB_IPINTERFACE_ROW Row
);

Parameters

  • Row
    A pointer to a MIB_IPINTERFACE_ROW structure to initialize. On successful return, the fields in this parameter are initialized with default information for an interface on the local device.

Return Value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Return code

Description

ERROR_INVALID_PARAMETER

An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the Row parameter.

Other

Use FormatMessage to obtain the message string for the returned error.

Remarks

On output, the Family member in the MIB_IPINTERFACE_ROW structure pointed to by the Row parameter will be initialized to either AF_UNSPEC, the InterfaceLuid member in the MIB_IPINTERFACE_ROW structure will be initialized to an unspecified value, and other fields are initialized to zero.

The InitializeIpInterfaceEntry function must be used to initialize the fields of a MIB_IPINTERFACE_ROW structure entry with default values. An application can then change the fields in the MIB_IPINTERFACE_ROW entry it wishes to modify, and then call the SetIpInterfaceEntry function.

See Also

Reference

IP Helper Functions
GetIpInterfaceEntry
GetIpInterfaceTable
MIB_IPINTERFACE_ROW
MIB_IPINTERFACE_TABLE
SetIpInterfaceEntry

Other Resources

IP Helper