Skip to content

Latest commit

 

History

History
139 lines (108 loc) · 3.49 KB

nf-mprapi-mprinfoblockremove.md

File metadata and controls

139 lines (108 loc) · 3.49 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mprapi.MprInfoBlockRemove
MprInfoBlockRemove function (mprapi.h)
The MprInfoBlockRemove function creates a new header that is identical to an existing header with a specified block removed.
MprInfoBlockRemove
MprInfoBlockRemove function [RAS]
_mpr_mprinfoblockremove
mprapi/MprInfoBlockRemove
rras.mprinfoblockremove
rras\mprinfoblockremove.htm
RRAS
2d124541-c954-4031-95cd-68a96c8e0a77
12/05/2018
MprInfoBlockRemove, MprInfoBlockRemove function [RAS], _mpr_mprinfoblockremove, mprapi/MprInfoBlockRemove, rras.mprinfoblockremove
mprapi.h
Windows
None supported
Windows 2000 Server [desktop apps only]
Mprapi.lib
Mprapi.dll
Windows
19H1
MprInfoBlockRemove
mprapi/MprInfoBlockRemove
c++
APIRef
kbSyntax
DllExport
Mprapi.dll
MprInfoBlockRemove

MprInfoBlockRemove function

-description

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

-parameters

-param lpHeader [in]

Pointer to the header from which the block should be removed.

-param dwInfoType [in]

Specifies the type of block to be removed. The types available depend on the transport: IP or IPX.

-param lplpNewHeader [out]

Pointer to a pointer variable that receives the new header.

-returns

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
ERROR_INVALID_PARAMETER
The lpHeader parameter 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 that corresponds to the returned error code.

-remarks

After removing an information block, obtain the new size of the information header by call MprInfoBlockQuerySize.

-see-also

FormatMessage

MprInfo Functions and Information Headers

MprInfoBlockAdd

MprInfoBlockQuerySize