MbufFreeComponent

See also

User Guide:

Child containers Components Preparing a container for display or processing

Reference:

MbufAllocComponent MbufFree MbufInquireContainer

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/GPm

Available on Matrox Supersight

Function map

Examples

simple3dbinpicking.cpp
simple3dstitching.cpp

Function Map

- Component

Table:	For specifying which component to free using a uniquely identifying criterion
Table:	For specifying which components to free using a generalized criterion
Table:	For specifying the component to free by component type

- ControlFlag

Compilation information

Synopsis

Free one or more buffer components of a specified container.

Syntax

void MbufFreeComponent(

MIL_ID ContainerBufId,	//in
MIL_INT64 Component,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function deallocates one or more previously allocated buffer components of the specified container. The memory reserved for the specified component is released.

Child buffers associated with the component must be deallocated, using MbufFree(), prior to deallocating the component.

All buffers allocated on a particular system must be freed before the system can be freed.

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

ContainerBufId

Specifies the MIL identifier of the container which contains the component(s) to be freed.

Component

Specifies the criterion used to determine which component(s) will be freed from the container. For all settings except M_COMPONENT_ALL or a component type, an error will be generated if no components of the container specified in ContainerBufId meet the criterion.

These settings can be used to free a single component that can be uniquely identified.

For specifying which component to free using a uniquely identifying criterion
Value	Description
M_COMPONENT_BY_ID( MIL_ID ID )	Specifies the component with the specified MIL identifier. (summarize) Specifies the component with the specified MIL identifier. (more details...)
		Parameters
		ID Specifies the MIL identifier of the component.
M_COMPONENT_BY_INDEX( MIL_INT ComponentIndex )	Specifies the component with the specified index in the container. (summarize) Specifies the component with the specified index in the container. (more details...)
		Parameters
		ComponentIndex Specifies the index of the component.

These settings can be used to free one or more components that can be identified by a generalized criterion.

For specifying which components to free using a generalized criterion
Value	Description
M_COMPONENT_BY_GROUP_ID( MIL_INT GroupIndex )	Specifies that the component(s) have the specified group ID. The group ID of a component can be inquired using MbufInquireContainer() with M_COMPONENT_GROUP_ID. (summarize) Specifies that the component(s) have the specified group ID. (more details...)
		Parameters
		GroupIndex Specifies the group ID.
M_COMPONENT_BY_REGION_ID( MIL_INT RegionID )	Specifies that the component(s) have the specified region ID. The region ID of a component can be inquired using MbufInquireContainer() with M_COMPONENT_REGION_ID. (summarize) Specifies that the component(s) have the specified region ID. (more details...)
		Parameters
		RegionID Specifies the region ID.
M_COMPONENT_BY_SOURCE_ID( MIL_INT SourceID )	Specifies that the component(s) have the specified source ID. The source ID of a component can be inquired using MbufInquireContainer() with M_COMPONENT_SOURCE_ID. (summarize) Specifies that the component(s) have the specified source ID. (more details...)
		Parameters
		SourceID Specifies the source ID.
M_COMPONENT_ALL	Specifies all components of the container.

These settings can be used to free one or more components with the specified component type.

For specifying the component to free by component type
Value	Description
M_COMPONENT_CONFIDENCE	Specifies the components that store confidence information for a M_COMPONENT_RANGE or M_COMPONENT_DISPARITY component of the container. INFO
M_COMPONENT_CUSTOM + n	Specifies the components that have a custom component type , identified by n, where n can be a value between 0 and 254. INFO
M_COMPONENT_DISPARITY	Specifies the components that store a disparity map. INFO
M_COMPONENT_INFRARED	Specifies the components that store an intensity image of infrared light.
M_COMPONENT_INTENSITY	Specifies the components that store an intensity image of visible light.
M_COMPONENT_MESH_MIL	Specifies the components that store mesh information for a M_COMPONENT_RANGE component of the container. INFO
M_COMPONENT_METADATA	Specifies the components that store metadata information. INFO
M_COMPONENT_MULTISPECTRAL	Specifies the components that store an intensity image where each band represents the intensity of a specific wavelength of light. INFO
M_COMPONENT_NORMALS_MIL	Specifies the components that store normals information for each point in the M_COMPONENT_RANGE component of the container. INFO
M_COMPONENT_RANGE	Specifies the components that store 3D distance/position information. INFO
M_COMPONENT_REFLECTANCE	Specifies the components that store a reflectance map. INFO
M_COMPONENT_SCATTER	Specifies the components that store a scatter map. INFO
M_COMPONENT_ULTRAVIOLET	Specifies the components that store an intensity image of ultraviolet light.
M_COMPONENT_UNDEFINED	Specifies the components that store information of an unknown type.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information

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