| MIL 10 Reference
| Customize Help
| Save Settings

MbufGet


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MbufGet2d
MbufGetArc
Synopsis
Get data from a buffer and place it in a user-supplied array.
Syntax
void MbufGet(
MIL_ID SrcBufId, //in
void *UserArrayPtr //out
)
Description

This function copies data from a specified MIL source buffer to a user-supplied array. If the source buffer has multiple bands, MIL copies all bands, one after the other. The internal data format of the source buffer need not match the data format of the user-supplied array (planar); an internal conversion will be performed if necessary. Note, however, if the formats do match, the operation will be much faster. For more information, refer to MbufGetColor() with M_PLANAR.

If the specified buffer is a binary image buffer, any extra bits to complete a byte in the array are undefined.

If the source buffer is compressed, MIL decompresses the data before copying it to the user-supplied array.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
SrcBufId

Specifies the identifier of the source buffer.

If the specified buffer is an image buffer with an associated region of interest (ROI), an error will occur.

UserArrayPtr
Accepts the address of one of the following:
  • array of same type as the buffer

Specifies the address of the user array in which to copy the data from the source buffer. Ensure that the user array is large enough to receive the data to be copied from the source buffer.

Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
NONE