MprInfoBlockRemove

[This is preliminary documentation and subject to change.]

The MprInfoBlockRemove function creates a new header that is identical to an existing header with a specified block removed.

DWORD MprInfoBlockRemove(
  LPVOID   lpInfoBlock,        // pointer to existing header 
  DWORD    dwInfoType,         // info type of block to remove 
  LPVOID * lplpNewInfoBlock    // new header with block removed 
);

Parameters

lpInfoBlock
Pointer to the header from which the block should be removed.
dwInfoType
Specifies the type of block to be removed. The types available depend on the transport: IP or IPX.
lplpNewInfoBlock
Pointer to a pointer variable that, on successful, return, points to the new 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 lpInfoBlock is NULL, or no block of type dwInfoType exists in the header.
ERROR_NOT_ENOUGH_MEMORY The memory allocation required for successful execution of MprInfoBlockRemove could not be completed.
Other The call failed. Use FormatMessage to retrieve the error message corresponding to the returned error code.

See Also

FormatMessage, MprInfoBlockAdd