MstrPreprocess
- See also
Availability
Function map
- Examples
MstrInquire
- MstrRead
in the MIL Reference for the minimum update required.
| MIL_ID ContextId, | //in |
| MIL_INT64 ControlFlag | //in |
DescriptionThis function prepares the specified String Reader context, font, and string model to be read.
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.
In a typical application, MstrPreprocess() is called once. To preprocess a String Reader context without error, the context must have at least one font, one character, and one string model.
When you save a String Reader context, the preprocessing changes are not saved. Upon restoration, you must preprocess the context again.
ParametersSpecifies the String Reader context to preprocess. The String Reader context must have been previously allocated on the system using MstrAlloc().
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...) |
||||||||||||||||||||||||||||||||||||||
| Header | Include mil.h. |
| Library | Use mil.lib; milstr.lib. |
| DLL | Requires mil.dll; milstr.dll. |