PGET_GLOBAL_INFO callback function (routprot.h)

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

Syntax

PGET_GLOBAL_INFO PgetGlobalInfo;

DWORD PgetGlobalInfo(
  [in] PVOID GlobalInfo,
       PULONG BufferSize,
       PULONG StructureVersion,
       PULONG StructureSize,
       PULONG StructureCount
)
{...}

Parameters

[in] GlobalInfo

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

BufferSize

StructureVersion

StructureSize

StructureCount

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.

Value	Description
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.

 

 

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	routprot.h

See also

Routing Protocol Interface Functions

Routing Protocol Interface Reference

SetGlobalInfo

SetInterfaceInfo