MprInfoBlockFind

[This is preliminary documentation and subject to change.]

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

DWORD MprInfoBlockFind(
  LPVOID   lpInfoBlock,     // info header to search 
  DWORD    dwInfoType,      // block type to search for
  LPDWORD  lpdwItemSize,    // size of data items in found block 
  LPDWORD  lpdwItemCount,   // number of data items in found block 
  LPBYTE * lplpItemData     // data in found block 
);
 

Parameters

lpInfoBlock

Header in which to locate the block.

dwInfoType

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

lpdwItemSize

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

lpdwItemCount

Pointer to a DWORD variable that, on successful return, specifies 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 will not be returned.

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 will not be returned.

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.

See Also

FormatMessage