MmetName

See also

Reference:

MmetAlloc MmetAllocResult

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

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)

Fully supported on:

Fully supported on Host system (a)

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

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

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

Fully supported on Matrox Solios eA/XA (l)

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

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

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

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

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

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

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

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

Fully 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

metrologyalignment.cpp
metrologyinspectiontask.cpp

Function Map

- Operation

Table:

For specifying the operation to perform

- LabelOrIndex

Table:

For specifying the label or index value

- String

- ValuePtr

- ControlFlag

Compilation information

Synopsis

Set or retrieve the name of a feature or tolerance, or retrieve the label or index of a specified feature or tolerance.

Syntax

void MmetName(

MIL_ID ContextOrResultId,	//in
MIL_INT64 Operation,	//in
MIL_INT LabelOrIndex,	//in
MIL_TEXT_PTR String,	//in-out
MIL_INT *ValuePtr,	//out
MIL_INT64 ControlFlag	//in

)

Description

This function allows you to set or retrieve the name of a metrology feature or tolerance. It also allows you to retrieve either the label or index of a feature or tolerance based on its name.

Note that MmetName() supports Unicode.

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

ContextOrResultId

Specifies the identifier of the metrology context or result buffer containing the feature or tolerance to read or modify. The metrology context or the metrology result buffer must have been previously allocated on the required system using MmetAlloc() or MmetAllocResult(), respectively.

Operation

Specifies the type of operation to perform.

For specifying the operation to perform
Value	Description
M_GET_FEATURE_INDEX	Retrieves the index of a feature, based on its name. Set the LabelOrIndex parameter to M_DEFAULT. If there is no feature with the specified name, the returned index is -1. (summarize) Retrieves the index of a feature, based on its name. (more details...)
M_GET_FEATURE_LABEL	Retrieves the label of a feature, based on its name. Set the LabelOrIndex parameter to M_DEFAULT. If there is no feature with the specified name, the returned label is 0. (summarize) Retrieves the label of a feature, based on its name. (more details...)
M_GET_NAME	Retrieves the name of the feature or tolerance defined by the LabelOrIndex parameter. The name of the feature or tolerance is returned via the String parameter, and the name's length is returned via the ValuePtr parameter. To determine the exact size name, call this function twice, the first time to determine the size of the name, with the String parameter set to M_NULL, and the second time to return the name. (summarize) Retrieves the name of the feature or tolerance defined by the LabelOrIndex parameter. (more details...)
M_GET_TOLERANCE_INDEX	Retrieves the index of a tolerance, based on its name. Set the LabelOrIndex parameter to M_DEFAULT. If there is no tolerance with the specified name, the returned index is -1. (summarize) Retrieves the index of a tolerance, based on its name. (more details...)
M_GET_TOLERANCE_LABEL	Retrieves the label of a tolerance, based on its name. Set the LabelOrIndex parameter to M_DEFAULT. If there is no tolerance with the specified name, the returned label is 0. (summarize) Retrieves the label of a tolerance, based on its name. (more details...)
M_SET_NAME	Sets the name of the feature or tolerance defined by the LabelOrIndex parameter. This operation requires ContextOrResultId to be a valid context identifier. In addition, the specified name of the feature or tolerance (passed in the String parameter) must be unique, and ValuePtr must be set to M_NULL. Note that you can release a name by passing M_NULL to String. (summarize) Sets the name of the feature or tolerance defined by the LabelOrIndex parameter. (more details...)

LabelOrIndex

Specifies the label or index value of the metrology feature or tolerance. Set this parameter to M_DEFAULT when not required by the name operation.

For specifying the label or index value

Value

Description

M_FEATURE_INDEX(

MIL_INT FeatureIndex

)

Specifies a feature by indicating its index.

(summarize)

Specifies a feature by indicating its index.

(more details...)

Parameters

FeatureIndex

Set this parameter to the following:

Value >= 0

Specifies the index of the feature. Note that the index of the global frame is 0.

M_FEATURE_LABEL(

MIL_INT FeatureLabel

)

Specifies a feature by indicating its label.

(summarize)

Specifies a feature by indicating its label.

(more details...)

Parameters

FeatureLabel

Set this parameter to the following:

Value > 0

Specifies the label of the feature.

M_TOLERANCE_INDEX(

MIL_INT ToleranceIndex

)

Specifies a tolerance by indicating its index.

(summarize)

Specifies a tolerance by indicating its index.

(more details...)

Parameters

ToleranceIndex

Set this parameter to the following:

Value >= 0

Specifies the index of the tolerance.

M_TOLERANCE_LABEL(

MIL_INT ToleranceLabel

)

Specifies a tolerance by indicating its label.

(summarize)

Specifies a tolerance by indicating its label.

(more details...)

Parameters

ToleranceLabel

Set this parameter to the following:

Value > 0

Specifies the label of the tolerance.

String

Specifies the name to set or retrieve, depending on the Operation parameter.

Set this parameter to M_NULL and the Operation parameter to M_SET_NAME to disassociate the name from the tolerance or feature.

Set this parameter to M_NULL and the Operation parameter to M_GET_NAME to determine the length of the string.

Note that when setting a feature or tolerance name with the String parameter, the name must be unique (this does not apply when Operation is set to M_GET_NAME).

ValuePtr

Specifies the address at which to write the requested information.

This parameter must be set to M_NULL when not in use.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information

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