MbufAllocComponent

See also

User Guide:

3D Image Processing module overview 3D containers overview 3D coordinate systems and the coordinates of a point cloud Basic concepts for 3D containers Components Generating fully corrected depth and intensity maps Working with non-compliant cameras Working with points in a point cloud

Reference:

MappGetError MbufAlloc2d MbufAllocColor MbufChildContainer MbufFree MbufFreeComponent MbufInquireContainer MsysControl

Availability

Available in MIL-Lite with restrictions (see remarks)

Available in MIL

Available on Windows with restrictions

Available on Linux with restrictions

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Partially supported on:

Partially supported on Host system (a)

Partially supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Partially supported on Matrox Morphis (g)

Partially supported on Matrox Morphis QxT (h)

Partially supported on Matrox Orion HD (i)

Partially supported on Matrox Radient eCL (j)

Partially supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Partially supported on Matrox Solios eA/XA (l)

Partially supported on Matrox Solios ecl/xcl/ev-cl (m)

Partially supported on Matrox USB3 Vision driver (Update 19) (o)

Partially supported on Matrox RadientPro-CL (Update 7) (p)

Partially supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Partially supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Partially supported on Matrox Clarity UHD (Update 36 or 76) (u)

Partially supported on Matrox GenTL driver (Update 34) (v)

Partially supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Partially supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

3dmodelheightdefect.cpp
m3dreg.cpp
m3dreg.cs
m3dreg.vb
mimlocatepeak1d.cpp
mimlocatepeak1d.cs
mimlocatepeak1d.vb
simple3dbinpicking.cpp
simple3dstitching.cpp
sphereinspection.cpp

Function Map

- SizeBand

- SizeX

- SizeY

- Type

Table:	For the data depth of the component
+ combination:	For specifying the data type of the buffer

- Attribute

Table:	For specifying the buffer usage
+ combination:	For specifying the intended purpose of the image buffer
+ combination:	For allocating an overscan region
+ combination:	For specifying the compression type
+ combination:	For specifying a storage format and a location specifier
+ combination:	For specifying that the buffer is FPGA accessible
+ combination:	For specifying a storage format for color buffers
+ combination:	For specifying a planar color buffer format
+ combination:	For specifying a packed color buffer format
+ combination:	For specifying a packed or planar color buffer format
+ combination:	For specifying a location for a buffer
+ combination:	For specifying a memory bank to be used
+ combination:	For specifying a location in a specific type of memory
+ combination:	For specifying the attribute of the specified physical memory type

- ComponentType

Table:

For specifying the type of component

- ComponentIdPtr

Return value

Remarks

Compilation information

Synopsis

Allocate a buffer and add it as a component of a container.

Syntax

MIL_ID MbufAllocComponent(

MIL_ID ContainerBufId,	//in
MIL_INT SizeBand,	//in
MIL_INT SizeX,	//in
MIL_INT SizeY,	//in
MIL_INT Type,	//in
MIL_INT64 Attribute,	//in
MIL_INT64 ComponentType,	//in
MIL_ID *ComponentIdPtr	//out

)

Description

This function allocates a buffer and adds it as a component of a container. The buffer is allocated on the same system as the container.

Note that typically you do not need to manually allocate components. MIL typically allocates/reallocates components as required when the container is used as a destination for a grabbing or processing function.

After allocating the component, you should check that the operation was successful (either using MappGetError(), or by verifying that the buffer identifier returned is not Null).

When the component is no longer required, free it using MbufFreeComponent() or free its container using MbufFree().

Note that in some cases, a component allocated using MbufAllocComponent() might be freed and reallocated automatically if its container is the destination for a MIL function (such as a grabbing or 3D processing function). If the buffer is reallocated, its MIL identifier will change. If you need to access the component directly using its MIL buffer identifier, you should inquire its MIL identifier (using MbufInquireContainer() with M_COMPONENT_ID) any time its container is passed as the destination of a MIL function.

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 which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

ContainerBufId

Specifies the MIL identifier of the container to which to add the component.

SizeBand INQ

Specifies the number of (x,y) surfaces (also called bands) to allocate to the buffer. When allocating a buffer to store color, specify one band for each color, or other type of data, that the buffer needs to store (for example, monochrome images require one color band; RGB color images require three color bands). This parameter can be set to any non-zero integer value. However, in general, only 1- and 3-band buffers are allowed.

SizeX INQ

Specifies the buffer width. The units are determined by the selected buffer attribute. For example, if the buffer has an image buffer attribute, width is specified in pixels.

SizeY INQ

Specifies the buffer height. The units are determined by the selected buffer attribute. For example, if the buffer has an image buffer attribute, height is specified in pixels.

Type INQ

Specifies a combination of two values: data type and data depth per band. Specify the depth of the buffer per band as one of the following:

For the data depth of the component
Value	Description
1 +	Specifies a 1-bit (packed binary) buffer. INFO
8 +	Specifies an 8-bit buffer.
16 +	Specifies a 16-bit buffer.
32 +	Specifies a 32-bit buffer.

Combination values for 1; 8; 16; 32.

You can add one of the following values to the above-mentioned values to set the data type.

Supported data types depend on the specified depth.

For specifying the data type of the buffer
Combination value	Description
M_FLOAT	Specifies that the type of data is floating-point. INFO
M_SIGNED	Specifies that the type of data is signed. INFO
M_UNSIGNED	Specifies that the type of data is unsigned. INFO This is the default value. (summarize) Specifies that the type of data is unsigned. INFO (more details...)

Attribute INQ

Specifies the buffer usage. MIL uses this information to determine where to allocate the buffer in physical memory.

Set this parameter to one of the following values:

For specifying the buffer usage
Value	Description
M_ARRAY +	Specifies a buffer to store array type data. INFO
M_IMAGE +	Specifies a buffer to store image data.
M_KERNEL +	Specifies a kernel buffer to store a custom filter for convolution functions. INFO
M_LUT +	Specifies a buffer to store lookup table data. INFO
M_STRUCT_ELEMENT +	Specifies a buffer to store structuring element data for morphology functions. INFO

Combination values for M_IMAGE.

You can add one or more of the following values to the above-mentioned value to set the intended purpose of the image buffer.

Note that the component is always automatically assigned the intended usage attributes of its container (such as M_PROC or M_DISP). You can therefore optionally omit the intended purpose setting when allocating a component. You can still specify valid combination values for these settings if you omit them.

Attempting to allocate a component with one of the following attributes in a container that does not have the attribute will generate an error (aside from M_COMPRESS).

For specifying the intended purpose of the image buffer
Combination value	Description
M_COMPRESS +	Specifies an image buffer that can hold compressed data. INFO
M_DISP	Specifies an image buffer that can be displayed.
M_GRAB	Specifies an image buffer in which to grab data. INFO
M_PROC +	Specifies an image buffer that can be processed. INFO

Combination value for M_PROC.

You can add the following value to the above-mentioned value to set the allocation of an overscan region.

This overrides the MsysControl() M_ALLOCATION_OVERSCAN system control setting and forces the allocation of an overscan region. When this attribute is set, the setting of the M_ALLOCATION_OVERSCAN_SIZE system control determines the size of the overscan region and the M_ALLOCATION_OVERSCAN setting is ignored.

Note that this attribute is only useful when added to a buffer on which you want to perform neighborhood processing operations.

For allocating an overscan region
Combination value	Description
M_ALLOCATION_OVERSCAN	Specifies that the buffer is allocated with an overscan region. INFO

Combination values for M_COMPRESS.

You can add one of the following values to the above-mentioned value to set the compression type.

The image buffer's data depth dictates which compression type can be selected.

For specifying the compression type
Combination value	Description
M_H264	[For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold H.264 data. This compression type is used when specifying a source of an input or a destination of an output for a sequence operation as an array of buffers (MseqDefine() with M_BUFFER_LIST). (summarize) [For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold H.264 data. (more details...)
M_JPEG2000_LOSSLESS	[For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG2000 lossless data. The supported data formats are: 1-band, 8- or 16-bit data, and 3-band, 8- or 16-bit data in M_RGB24 + M_PLANAR, M_RGB48 + M_PLANAR, or M_YUV24 + M_PLANAR format. (summarize) [For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG2000 lossless data. (more details...)
M_JPEG2000_LOSSY	[For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG2000 lossy data. The supported data formats are: 1-band, 8- or 16-bit data, and 3-band, 8- or 16-bit data in M_RGB24, M_RGB48, M_YUV9, M_YUV12, M_YUV16 + M_PLANAR, or M_YUV24 format. (summarize) [For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG2000 lossy data. (more details...)
M_JPEG_LOSSLESS	[For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossless data. The supported data formats are: 1-band, 8- or 16-bit data, and 3-band data in M_RGB24 or M_RGB48 format. (summarize) [For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossless data. (more details...)
M_JPEG_LOSSLESS_INTERLACED	[For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossless data in separate fields. The supported data formats are 1-band, 8- or 16-bit data. (summarize) [For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossless data in separate fields. (more details...)
M_JPEG_LOSSY	[For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossy data. The supported data formats are: 1-band 8-bit data, and 3-band 8-bit data in M_RGB24, M_YUV24, M_YUV12, M_YUV9, M_YUV16 + M_PLANAR, or M_YUV16 + M_PACKED format. This is the default value. (summarize) [For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossy data. (more details...)
M_JPEG_LOSSY_INTERLACED	[For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossy data in separate fields. The supported data formats are: 1-band 8-bit data, and 3-band 8-bit data in M_YUV16 + M_PACKED format. (summarize) [For essential MIL-Lite information, see remarks ] Specifies that the buffer will be used to hold JPEG lossy data in separate fields. (more details...)

Combination values for M_IMAGE.

You can add one of the following values to the above-mentioned value to set a storage format and a location specifier.

MIL automatically selects the most appropriate storage format according to the specified intended usage attribute. For general processing, MIL will convert the data when the function requires a different format. If the default storage format is not appropriate and you want to avoid conversion during a time critical operation, you can add a storage format and a location specifier.

For specifying a storage format and a location specifier
Combination value	Description	MIL system-specific tooltip (‡)
M_DIB	Forces the buffer to be a DIB buffer. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_DIRECTX	[This is only applicable to Windows] Forces the buffer to be a DirectX surface.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27		u U36	v	y U75	aa
M_GDI	Forces the buffer to be compatible with GDI. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_LINUX_MXIMAGE	[This is only applicable to Linux] Forces the buffer to be an X11 Ximage.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27		u U36	v	y U75	aa

Combination value for the values listed in For specifying the buffer usage; and for the following values: M_ARRAY; M_IMAGE; M_KERNEL; M_LUT; M_STRUCT_ELEMENT.

You can add the following value to the above-mentioned values to specify that the buffer is FPGA accessible.

Note that the following value cannot be used with M_COMPRESS or values in the For specifying a storage format and a location specifier table.

For specifying that the buffer is FPGA accessible
Combination value	Description	MIL system-specific tooltip (‡)
M_FPGA_ACCESSIBLE +	Forces the buffer to be allocated in a bank of memory that is accessible from the Processing FPGA. INFO	‡	j	l	m	p	r U27	aa

Combination values for M_IMAGE.

You can add one of the following values to the above-mentioned value to set a storage format for color buffers.

Note that the buffer must be a color buffer. Also note that it might be slower to use buffers that have been forced with one of these attributes. Although there is no right or wrong storage format to use, certain operations are optimized for some formats.

For specifying a storage format for color buffers INQ
Combination value	Description
M_PACKED +	Specifies that the buffer's bands are stored in packed format (color buffer only); that is, the pixel components are stored together (RGB RGB RGB...). INFO
M_PLANAR +	Specifies that the buffer's bands are stored in planar format (color buffer only); that is, each pixel is stored as three component planes (RRR... GGG... BBB...). INFO

Combination values for M_PLANAR.

You can add one of the following values to the above-mentioned value to set a planar color buffer format. Alternatively, you can add a value from For specifying a packed or planar color buffer format.

Note that the values below cannot be used with grab buffers (M_GRAB), unless otherwise stated.

For specifying a planar color buffer format
Combination value	Description	MIL system-specific tooltip (‡)
M_RGB3	Specifies 3-bit color depth (RGB 1:1:1) planar pixels.	‡	a	g	h	i	j	k M10	l	m	p	r U27	t U28	u U36	y U75	aa
M_YUV9	Specifies YUV9 planar pixels.	‡	a	g	h	i	j	k M10	l	m	p	r U27	t U28	u U36	y U75	aa
M_YUV12	Specifies YUV12 planar pixels.	‡	a	g	h	i	j	k M10	l	m	p	r U27	t U28	u U36	y U75	aa
M_YUV24	Specifies YUV24 planar pixels.	‡	a	g	h	i	j	k M10	l	m	p	r U27	t U28	u U36	y U75	aa

Combination values for M_PACKED.

You can add one of the following values to the above-mentioned value to set a packed color buffer format. Alternatively, you can add a value from For specifying a packed or planar color buffer format.

Note that the values below cannot be used with grab buffers (M_GRAB), unless otherwise stated.

For specifying a packed color buffer format
Combination value	Description	MIL system-specific tooltip (‡)
M_BGR24	Specifies 24-bit color depth packed pixels (BGRBGR). INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_BGR32	Specifies 32-bit color depth packed pixels (BGRXBGRX). INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_RGB15	Specifies 16-bit color depth packed pixels (XRGB 1:5:5:5). INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_RGB16	Specifies 16-bit color depth packed pixels (RGB 5:6:5). INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_YUV16_UYVY	Specifies YUV16 packed (4:2:2) pixels, whereby the components of each pixel are stored in the UYVY order. INFO	‡		c M10								o					v
M_YUV16_YUYV	Specifies YUV16 packed (4:2:2) pixels, whereby the components of each pixel are stored in the YUYV order. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa

Combination values for the values listed in For specifying a storage format for color buffers.

You can add one of the following values to the above-mentioned values to set a packed or planar color buffer format. Alternatively, you can add a value from For specifying a packed color buffer format or from For specifying a planar color buffer format.

Note that the values below cannot be used with grab buffers (M_GRAB), unless otherwise stated.

For specifying a packed or planar color buffer format
Combination value	Description
M_RGB24	Specifies 24-bit color depth (RGB 8:8:8) packed or planar pixels. INFO
M_RGB48	Specifies 48-bit color depth (RGB 16:16:16). INFO
M_RGB96	Specifies 96-bit color depth (RGB 32:32:32) packed or planar pixels.
M_YUV16	Specifies YUV16 (4:2:2) pixels. INFO

Combination values for M_ARRAY; M_IMAGE; M_KERNEL; M_LUT; M_STRUCT_ELEMENT.

You can add one of the following values to the above-mentioned values to set a location for a buffer.

For specifying a location for a buffer
Combination value	Description	MIL system-specific tooltip (‡)
M_HOST_MEMORY +	Forces the buffer in Host memory. This is the default value. (summarize) Forces the buffer in Host memory. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_MAPPABLE	Forces the buffer to be allocated in non-paged memory that can be set in the address space of the process (Host memory). INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_OFF_BOARD	Ensures that the buffer is not in on-board memory. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_ON_BOARD +	Forces the buffer in on-board memory. INFO	‡			g	h	i	j	k M10	l	m		p	r U27	t U28	u U36		y U75	aa
M_VIDEO_MEMORY	Forces the buffer in (off-screen) display memory of your graphics controller. INFO	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa

Combination value for the values listed in For specifying that the buffer is FPGA accessible; and for the following values: M_HOST_MEMORY; M_ON_BOARD.

You can add the following value to the above-mentioned values to specify a memory bank to be used.

For specifying a memory bank to be used
Combination value	Description
M_MEMORY_BANK_n	Forces the buffer to be allocated in the specified memory bank. INFO

Combination values for the values listed in For specifying that the buffer is FPGA accessible; and for the following value: M_ON_BOARD.

You can add one of the following values to the above-mentioned values to set a location in a specific type of memory.

For specifying a location in a specific type of memory
Combination value	Description	MIL system-specific tooltip (‡)
M_FAST_MEMORY	Specifies that the buffer is in the fastest memory available. INFO	‡	j		l	m	p
M_SHARED	Specifies that the buffer is in shared processing memory. INFO	‡	j	k M10	l	m	p	r U27	y U75	aa

Combination values for M_ARRAY; M_IMAGE; M_KERNEL; M_LUT; M_STRUCT_ELEMENT.

You can add one of the following values to the above-mentioned values to set the attribute of the specified physical memory type.

For specifying the attribute of the specified physical memory type
Combination value	Description
M_NON_PAGED	Forces the buffer in MIL-reserved, non-pageable memory.
M_PAGED	Forces the buffer in pageable memory.

ComponentType

Specifies the component type, which identifies what kind of information the component stores.

For specifying the type of component
Value	Description
M_DEFAULT	Specifies the default component type. The default component type for image buffers is M_COMPONENT_INTENSITY. The default component type for all other buffers is M_COMPONENT_UNDEFINED. (summarize) Specifies the default component type. (more details...)
M_COMPONENT_CONFIDENCE	Specifies that the component stores confidence information for the M_COMPONENT_RANGE or M_COMPONENT_DISPARITY component of the container. Coordinates associated with the confidence value 0 are considered invalid data and will not be used by 3D image processing functions. A confidence component is associated with a range or disparity component in the same container when there are no other range, disparity, or confidence components in the container. If there is more than one range, disparity, and/or confidence component in a container (for example, because a single grab into the container transmitted multiple range and confidence components), you will need to either create a child container which contains only the required components using MbufChildContainer(), or free the extra components using MbufFreeComponent(). (summarize) Specifies that the component stores confidence information for the M_COMPONENT_RANGE or M_COMPONENT_DISPARITY component of the container. (more details...)
M_COMPONENT_CUSTOM + n	Specifies that the component has a custom component type, identified by n, where n can be a value between 0 and 254. You can use custom component types to identify components which store information that does not fit one of the standard component types. In addition, some cameras transmit components with custom component types. Refer to your camera manual to determine what type of information is stored in transmitted components. (summarize) Specifies that the component has a custom component type, identified by n, where n can be a value between 0 and 254. (more details...)
M_COMPONENT_DISPARITY	Specifies that the component stores a disparity map. Each pixel of a disparity map indicates the apparent distance (typically measured in pixel units) between where an object appears in the left and right images captured by a stereoscopic camera. (summarize) Specifies that the component stores a disparity map. (more details...)
M_COMPONENT_INFRARED	Specifies that the component stores an intensity image of infrared light.
M_COMPONENT_INTENSITY	Specifies that the component stores an intensity image of visible light.
M_COMPONENT_MESH_MIL	Specifies that the component stores mesh information for the M_COMPONENT_RANGE component of the container. A mesh component is associated with a range component in the same container when there are no other range or mesh components in that container. A point cloud container which has a mesh component is referred to as a meshed point cloud container. (summarize) Specifies that the component stores mesh information for the M_COMPONENT_RANGE component of the container. (more details...)
M_COMPONENT_METADATA	Specifies that the component stores metadata information. Metadata components are used by MIL internally. Typically, you should ignore metadata components in your application. (summarize) Specifies that the component stores metadata information. (more details...)
M_COMPONENT_MULTISPECTRAL	Specifies that the component stores an intensity image where each band represents the intensity of a specific wavelength of light. Unlike an intensity component, a multispectral component might include information about non-visible light. (summarize) Specifies that the component stores an intensity image where each band represents the intensity of a specific wavelength of light. (more details...)
M_COMPONENT_NORMALS_MIL	Specifies that the component stores normals information for each point in the M_COMPONENT_RANGE component of the container. A normals component is associated with a range component in the same container when there are no other range or normals components in that container. (summarize) Specifies that the component stores normals information for each point in the M_COMPONENT_RANGE component of the container. (more details...)
M_COMPONENT_RANGE	Specifies that the component stores 3D distance/position information. This can be either a 1-band buffer that stores a depth map, or a 3-band buffer that stores coordinates of 3D points. (summarize) Specifies that the component stores 3D distance/position information. (more details...)
M_COMPONENT_REFLECTANCE	Specifies that the component stores a reflectance map. Each pixel of a reflectance map indicates how much of the light hitting an object at that location is reflected back. Typically, this is an intensity image of the light spectrum used by a 3D sensor to detect 3D distance/position information. Typically, if the map was generated by a laser profiler, each row indicates the detected intensity of the laser for a single scan. (summarize) Specifies that the component stores a reflectance map. (more details...)
M_COMPONENT_SCATTER	Specifies that the component stores a scatter map. Each pixel of a scatter map indicates how much of the light hitting an object at that location is detected scattering beneath the object's surface. (summarize) Specifies that the component stores a scatter map. (more details...)
M_COMPONENT_ULTRAVIOLET	Specifies that the component stores an intensity image of ultraviolet light.
M_COMPONENT_UNDEFINED	Specifies that the component stores information of an unknown type.

ComponentIdPtr

Specifies the address of the variable in which to write the buffer identifier. Since the MbufAllocComponent() function also returns the buffer identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

Return value

The returned value is the buffer identifier. If allocation fails, M_NULL is returned.

Remarks

If you are creating a DLL that includes a call to MbufAllocComponent(), ensure that the call is not made from the DllMain() function, because MbufAllocComponent() might load a required DLL and you cannot load a DLL from DllMain(). If necessary, call MbufAllocComponent() from an initialization function in your DLL instead.

[MIL-Lite]

Note that during development and at runtime, compression support, particularly for an M_COMPRESS buffer type, requires the presence of a MIL license that grants access to the compression/decompression package. This access is only granted by default with the development license dongle for the full version of MIL. In other cases, you must purchase access to this package separately.

[MIL-Lite]

You can allocate a buffer with an M_KERNEL or an M_STRUCT_ELEMENT attribute with MIL-Lite. However, these attributes are not required to work under MIL-Lite.

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.