MstrPreprocess

This function prepares the specified String Reader context, font, and string model to be read. Essentially, MstrPreprocess() makes the context ready for the read operation.

This function must be called before the first call to MstrRead(). Changes to control settings, the String Reader context, one of its font or string models often require you to re-preprocess the context. To inquire if you need to preprocess or re-preprocess the context, use MstrInquire() with M_PREPROCESSED.

Note that in a typical application, MstrPreprocess() is called once. Also note that, to preprocess a String Reader context without an error, the context must have at least one font, one character, and one string.

When you save the String Reader context, the preprocessing changes are not saved. Upon restoration, you must preprocess the context again.

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

ContextId

Specifies the String Reader context to preprocess. The String Reader context must have been previously allocated on the system using MstrAlloc().

ControlFlag

Specifies whether to preprocess the String Reader context. Set this parameter to one of the following values:

For specifying whether to preprocess the context
Value	Description
M_DEFAULT	Preprocesses the String Reader context.
M_RESET	Un-preprocesses the String Reader context. Un-preprocessing the String Reader context can be useful if you want to conserve system memory within an application and preserve String Reader context settings. (summarize) Un-preprocesses the String Reader context. (more details...)

Compilation information

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