Edit

Share via

MprInfoBlockFind function (mprapi.h)

  • Article

The MprInfoBlockFind function locates a specified block in an information header, and retrieves information about the block.

Syntax

DWORD MprInfoBlockFind(
  [in]  LPVOID  lpHeader,
  [in]  DWORD   dwInfoType,
  [out] LPDWORD lpdwItemSize,
  [out] LPDWORD lpdwItemCount,
  [out] LPBYTE  *lplpItemData
);

Parameters

[in] lpHeader

Specifies the header in which to locate the block.

[in] dwInfoType

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

[out] lpdwItemSize

Pointer to a DWORD variable that receives the size of each item in the located block's data. This parameter is optional. If this parameter is NULL, the item size is not returned.

[out] lpdwItemCount

Pointer to a DWORD variable that receives the number of items of size dwItemSize contained in the block's data. This parameter is optional. If this parameter is NULL, the item count is not returned.

[out] lplpItemData

Pointer to a pointer that, on successful return, points to the data for the located block. This parameter is optional. If this parameter is NULL, the data is not returned.

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
ERROR_INVALID_PARAMETER
 The lpInfoHeader parameter is NULL.
ERROR_NOT_FOUND
 No block of type dwInfoType exists in the header.
Other
 The call failed. Use FormatMessage to retrieve the error message that corresponds to the returned error code.

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

See also

FormatMessage

MprInfo Functions and Information Headers