MprInfoCreate

[This is preliminary documentation and subject to change.]

The MprInfoCreate function creates a new information header.

DWORD MprInfoCreate(
  DWORD    dwVersion,          // version of info header
  LPVOID * lplpNewInfoBlock    // pointer to new info header
);
 

Parameters

dwVersion
Specifies the version of the RTR_INFO_BLOCK_HEADER structure to be created. The only value currently supported is RTR_INFO_BLOCK_VERSION, as declared in Rtinfo.h.
lplpNewInfoBlock
Pointer to the allocated and initialized header.

Return Values

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value will be one of the following values.

Value Description
ERROR_INVALID_PARAMETER The lplpNewInfoBlock is NULL.
ERROR_NOT_ENOUGH_MEMORY The requested memory allocation could not be completed.
Other The call failed. Use FormatMessage to retrieve the error message corresponding to the returned error code.

See Also

FormatMessage, RTR_INFO_BLOCK_HEADER.