MmeasAllocContext

See also

User Guide:

Measurements between two markers

Reference:

MmeasCalculate MmeasControl MmeasFindMarker MmeasFree MmeasInquire MsysAlloc

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

None.

Function Map

- SystemId

Table:

For specifying the system identifier

- ControlFlag

- ContextIdPtr

Return value

Compilation information

Synopsis

Allocate a measurement context.

Syntax

MIL_ID MmeasAllocContext(

MIL_ID SystemId,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContextIdPtr	//out

)

Description

This function allocates a measurement context on the specified system. MIL uses a measurement context to control the behavior of measurement operations (MmeasFindMarker() and MmeasCalculate()). You can modify the settings of a measurement context with MmeasControl(). When you no longer require a measurement context, release its memory using MmeasFree().

MIL allows you to specify M_DEFAULT as the identifier of the measurement context, when using MmeasFindMarker(), MmeasCalculate(), and MmeasInquire(); therefore, you need not call MmeasAllocContext(). However, you cannot specify M_DEFAULT as the identifier of the measurement context if want to modify it using MmeasControl(); to modify a measurement context, you must actually allocate it using MmeasAllocContext().

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

SystemId INQ

Specifies the system on which the to allocate the measurement context.

This parameter should be set to one of the following values:

For specifying the system identifier
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ContextIdPtr

Specifies the address of the variable in which the measurement context identifier is to be written. If allocation fails, M_NULL is written as the identifier. Since the MmeasAllocContext() function also returns the marker identifier, you can set this parameter to M_NULL.

Return value

The returned value is the measurement context identifier if the allocation is successful. If allocation fails, M_NULL is returned.

Compilation information

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