MstrAlloc

Filters
See also

User Guide:

Creating and customizing the fonts for a font-based context Steps to reading a string in an image

Reference:

MstrFree MstrRestore MsysAlloc

Availability

Not 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

mstr.cpp
mstr.cs
mstr.vb

Function Map

- SystemId

Table:

For specifying the system identifier

- ContextType

Table:

For specifying the context

- ControlFlag

- ObjectIdPtr

Return value

Compilation information

Synopsis

Allocates a String Reader context.

Syntax

MIL_ID MstrAlloc(

MIL_ID SystemId,	//in
MIL_INT64 ContextType,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ObjectIdPtr	//out

)

Description

This function allocates a String Reader context on the specified system. A String Reader context contains the read parameters, the list of fonts, and the list of string models. When the String Reader context is no longer required, you should release its memory, using MstrFree().

Note that you cannot allocate a fontless context. You must restore one of the predefined fontless context that is distributed with MIL using MstrRestore().

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

SystemId INQ

Specifies the system on which to allocate the String Reader 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().

ContextType

Specifies the type of String Reader context. This parameter must be set to the value below.

For specifying the context
Value	Description
M_FONT_BASED	Specifies a font-based context.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ObjectIdPtr

Specifies the address of the variable in which to write the String Reader context identifier. Since the MstrAlloc() function also returns the String Reader context identifier, you can set this parameter to M_NULL.

Return value

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

Compilation information

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