MprInfoBlockRemove function (mprapi.h)
The MprInfoBlockRemove function creates a new header that is identical to an existing header with a specified block removed.
Syntax
DWORD MprInfoBlockRemove(
[in] LPVOID lpHeader,
[in] DWORD dwInfoType,
[out] LPVOID *lplpNewHeader
);
Parameters
[in] lpHeader
Pointer to the header from which the block should be removed.
[in] dwInfoType
Specifies the type of block to be removed. The types available depend on the transport: IP or IPX.
[out] lplpNewHeader
Pointer to a pointer variable that receives the new header.
Return value
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following values.
Value | Description |
---|---|
|
The lpHeader parameter is NULL, or no block of type dwInfoType exists in the header. |
|
The memory allocation required for successful execution of MprInfoBlockRemove could not be completed. |
|
The call failed. Use FormatMessage to retrieve the error message that corresponds to the returned error code. |
Remarks
After removing an information block, obtain the new size of the information header by call MprInfoBlockQuerySize.
Requirements
Requirement | Value |
---|---|
Minimum supported client | None supported |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | mprapi.h |
Library | Mprapi.lib |
DLL | Mprapi.dll |