GetGlobalInfo

[This is preliminary documentation and subject to change.]

The GetGlobalInfo function retrieves global (as opposed to interface-specific) configuration information kept by the routing protocol.

DWORD GetGlobalInfo(
  PVOID GlobalInfo       // address of configuration information
  PULONG GlobalInfoSize  // size of configuration information
);
 

Parameters

GlobalInfo

Pointer to a buffer to receive the protocol-defined global configuration information. The format of this information is specific to the routing protocol.

GlobalInfoSize

Pointer to a DWORD variable.

On input: This variable contains the size, in bytes, of the buffer pointed to by the GlobalInfo parameter.

On output: This variable contains the size, in bytes, of the data placed in the output buffer. If the initial size was not large enough, the variable contains the size required to hold all of the output data.

Return Values

NO_ERROR

The routing protocol retrieved the global configuration information successfully. The information is in the buffer pointed to by GlobalInfo.

ERROR_CAN_NOT_COMPLETE

The routing protocol could not retrieve the global information.

ERROR_INSUFFICIENT_BUFFER

The size of the output buffer provided is not large enough to hold the requested information. The required size is returned in the DWORD variable pointed to by OutputDataSize.

ERROR_INVALID_PARAMETER

The GlobalInfoSize parameter is NULL.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in routprot.h.
  Import Library: user-defined.

See Also

GetGlobalInfo Sample, SetInterfaceConfigInfo, SetGlobalInfo