Share via

InitializeIpInterfaceEntry (NETIOAPI) (Compact 2013)

  • Article

3/26/2014

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

Syntax

VOID NETIOAPI_API
  InitializeIpInterfaceEntry(
    IN OUT 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

InitializeIpInterfaceEntry returns STATUS_SUCCESS if the function succeeds.

If the function fails, InitializeIpInterfaceEntry returns one of the following error codes:

Error Code

Meaning

STATUS_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 the FormatMessage function to obtain the message string for the returned error.

Remarks

On output, the members of the MIB_IPINTERFACE_ROW structure that the Row parameter points to are initialized as follows.

  • Family
    Set to AF_UNSPEC.
  • InterfaceLuid
    Set to an unspecified value.
  • All other members
    Set to zero.

Your driver must use the InitializeIpInterfaceEntry function to initialize the fields of a MIB_IPINTERFACE_ROW structure entry with default values. A driver can then change the fields in the MIB_IPINTERFACE_ROW entry that it wants to modify, and then call the SetIpInterfaceEntry (NETIOAPI) function.

See Also

Reference

IP Helper Kernel-Mode Functions
GetIpInterfaceEntry (NETIOAPI)
GetIpInterfaceTable (NETIOAPI)
MIB_IPINTERFACE_ROW
MIB_IPINTERFACE_TABLE
SetIpInterfaceEntry (NETIOAPI)