MIL_TEXT_PTR MemPtrOrFileName, | //in-out |
MIL_ID SysId, | //in |
MIL_INT64 Operation, | //in |
MIL_INT64 StreamType, | //in |
MIL_DOUBLE Version, | //in |
MIL_INT64 ControlFlag, | //in |
MIL_ID *ContextImIdPtr, | //in-out |
MIL_INT *SizeByteVarPtr | //out |
This function can load, restore, or save a image processing context from/to a file or memory stream, or save an augmentation report to a file.
To inquire the number of bytes necessary to save an image processing context to memory stream, you should first call this function (MimStream()) with M_INQUIRE_SIZE_BYTE.
The content saved to memory stream is equivalent to the content saved to file. This function is equivalent to a file saved using MimSave().
You can use this and other MIL stream functions, for example, to save all required MIL objects, as well as any other custom data, for your application to a memory stream. Once in a memory stream, you can write the stream to a single file or transfer it over a network. You are responsible for concatenating the streams and for saving the stream to file. When saving an image processing context, all information about the previously allocated image processing context is saved. The content saved to memory stream is equivalent to the content saved to file.
When loading or restoring an image processing context, all of the image processing context's settings that were in effect when the image processing context was saved will be restored. Note that, you can also restore an imaging processing context using MimRestore().
Using MimStream(), you can choose to save a backwards-compatible version of the image processing context, which will work using a version of MIL that is up to one major release older than the current version (depending on which version is specified). For example, if you allocate an image processing context using MIL 10.0 and save it to version 9.0, you can restore this context on a computer where MIL 9.0 is installed. However, all settings and features unique to the higher version will be ignored when restored using the lower version. Besides saving backwards-compatible versions, you can also load or restore image processing contexts saved using MIL version 9.0 or above. Settings that do not exist in the lower version will be filled with default values when the image processing context is loaded or restored.
Specifies the file or memory stream.
See the Parameter associations section for possible values that can be returned/specified.
Specifies the system on which to restore the image processing context.
See the Parameter associations section for possible values that can be specified.
Specifies the operation to perform on the image processing context.
See the Parameter associations section for possible values that can be specified.
Specifies the type of stream in which to store/from which to restore the image processing context. This parameter must be set to one of the following values:
Specifies the MIL version of the image processing context.
See the Parameter associations section for possible values that can be specified.
Specifies the address of the variable in which to write or from which to read the identifier of the image processing context. In the case of an M_SAVE_REPORT operation, this parameter specifies the address of the variable from which to read the identifier of the augmentation result buffer.
See the Parameter associations section for possible values that can be returned/specified.
The table below lists possible values for the MemPtrOrFileName, SysId, Operation, Version, and ContextImIdPtr parameters.
For performing the stream operation.
|
|||||||||||||||||||||||||||||||||||||||
|
Description | ||||||||||||||||||||||||||||||||||||||
MemPtrOrFileName - Possible values passed or returned |
|||||||||||||||||||||||||||||||||||||||
SysId | |||||||||||||||||||||||||||||||||||||||
Version | |||||||||||||||||||||||||||||||||||||||
ContextImIdPtr - Possible values passed or returned |
|||||||||||||||||||||||||||||||||||||||
M_INQUIRE_SIZE_BYTE |
Inquires the number of bytes required to save an image processing context to memory stream. This operation is not supported when the StreamType parameter is set to M_FILE. (summarize)Inquires the number of bytes required to save an image processing context to memory stream. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtrOrFileName |
This parameter must be set to M_NULL. (summarize)This parameter must be set to M_NULL. (more details...) |
||||||||||||||||||||||||||||||||||||||
SysId |
This parameter must be set to M_NULL. (summarize)This parameter must be set to M_NULL. (more details...) |
||||||||||||||||||||||||||||||||||||||
Version |
Specifies the MIL version with which the image processing context must be compatible when saved. The size of an image processing context might differ from one MIL version to another. (summarize)Specifies the MIL version with which the image processing context must be compatible when saved. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the current version of MIL. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_90 |
Specifies the version as being MIL 9.0. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_90_PP1 |
Specifies the version as being MIL 9.0 Processing Pack 1. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_90_PP2 |
Specifies the version as being MIL 9.0 Processing Pack 2. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100 |
Specifies the version as being MIL 10.0. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_PP1 |
Specifies the version as being MIL 10.0 Processing Pack 1. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_PP2 |
Specifies the version as being MIL 10.0 Processing Pack 2. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_PP3 |
Specifies the version as being MIL 10.0 Processing Pack 3. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_SP4 |
Specifies the version as being MIL 10.0 Service Pack 4. |
||||||||||||||||||||||||||||||||||||||
ContextImIdPtr |
Specifies the address of the variable containing the identifier of the image processing context. (summarize)Specifies the address of the variable containing the identifier of the image processing context. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_LOAD |
Loads the content of a specified file or memory stream into a previously allocated image processing context. (summarize)Loads the content of a specified file or memory stream into a previously allocated image processing context. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtrOrFileName |
Specifies the file or memory stream from which to load the context. (summarize)Specifies the file or memory stream from which to load the context. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTERACTIVE |
[This is
only applicable to Windows]
Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE. |
||||||||||||||||||||||||||||||||||||||
MIL_TEXT("FileName") 1 |
Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. Image processing contexts typically have an MIC file extension. The function handles (internally) the opening and closing of the file. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize)Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtr |
Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize)Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...) |
||||||||||||||||||||||||||||||||||||||
SysId |
This parameter must be set to M_NULL. (summarize)This parameter must be set to M_NULL. (more details...) |
||||||||||||||||||||||||||||||||||||||
Version |
This parameter must be set to M_DEFAULT. (summarize)This parameter must be set to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ContextImIdPtr |
Specifies the address of the variable containing the identifier of the image processing context. All previous settings are overwritten with those of the loaded context, or are set to the default value if the settings didn't exist in the version of MIL from which the context is being loaded. (summarize)Specifies the address of the variable containing the identifier of the image processing context. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_RESTORE |
Restores an image processing context from a file or memory stream and assigns it a MIL identifier. (summarize)Restores an image processing context from a file or memory stream and assigns it a MIL identifier. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtrOrFileName |
Specifies the file or memory stream from which to restore the context. (summarize)Specifies the file or memory stream from which to restore the context. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTERACTIVE |
[This is
only applicable to Windows]
Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE. |
||||||||||||||||||||||||||||||||||||||
MIL_TEXT("FileName") 1 |
Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. Image processing contexts typically have an MIC file extension. The function handles (internally) the opening and closing of the file. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize)Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtr |
Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize)Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...) |
||||||||||||||||||||||||||||||||||||||
SysId |
Specifies the system on which to allocate the image processing context. (summarize)Specifies the system on which to allocate the image processing context. (more details...) |
||||||||||||||||||||||||||||||||||||||
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(). |
||||||||||||||||||||||||||||||||||||||
Version |
This parameter must be set to M_DEFAULT. (summarize)This parameter must be set to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ContextImIdPtr |
Specifies the address of the variable in which to write the identifier of the image processing context. If the operation is not successful, M_NULL is returned. (summarize)Specifies the address of the variable in which to write the identifier of the image processing context. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_SAVE |
Saves an image processing context to a specified file or memory stream. (summarize)Saves an image processing context to a specified file or memory stream. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtrOrFileName |
Specifies the file or memory stream. (summarize)Specifies the file or memory stream. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTERACTIVE |
[This is
only applicable to Windows]
Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE. |
||||||||||||||||||||||||||||||||||||||
MIL_TEXT("FileName") 1 |
Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. For easier use with other Matrox Imaging software products, when saving a image processing context to a file, use the MIC file extension. The function handles (internally) the opening and closing of the file. If the file already exists, it will be overwritten. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize)Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtr |
Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which to write, and the block of memory must be large enough to stream the entire object. To determine the required size, call this function with M_INQUIRE_SIZE_BYTE. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize)Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...) |
||||||||||||||||||||||||||||||||||||||
SysId |
This parameter must be set to M_NULL. (summarize)This parameter must be set to M_NULL. (more details...) |
||||||||||||||||||||||||||||||||||||||
Version |
Specifies the MIL version with which the image processing context must be compatible when saved. Note that the image processing context can only be up to one major release older (MIL 9.0) than the current version. (summarize)Specifies the MIL version with which the image processing context must be compatible when saved. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the current version of MIL. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_90 |
Specifies the version as being MIL 9.0. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_90_PP1 |
Specifies the version as being MIL 9.0 Processing Pack 1. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_90_PP2 |
Specifies the version as being MIL 9.0 Processing Pack 2. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100 |
Specifies the version as being MIL 10.0. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_PP1 |
Specifies the version as being MIL 10.0 Processing Pack 1. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_PP2 |
Specifies the version as being MIL 10.0 Processing Pack 2. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_PP3 |
Specifies the version as being MIL 10.0 Processing Pack 3. |
||||||||||||||||||||||||||||||||||||||
M_PROC_VERSION_100_SP4 |
Specifies the version as being MIL 10.0 Service Pack 4. |
||||||||||||||||||||||||||||||||||||||
ContextImIdPtr |
Specifies the address of the variable containing the identifier of the image processing context to save. (summarize)Specifies the address of the variable containing the identifier of the image processing context to save. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_SAVE_REPORT |
Saves a report containing results from calling MimAugment() with an augmentation result buffer. (summarize)Saves a report containing results from calling MimAugment() with an augmentation result buffer. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtrOrFileName |
Specifies the file or memory stream. (summarize)Specifies the file or memory stream. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTERACTIVE |
[This is
only applicable to Windows]
Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set to M_FILE. |
||||||||||||||||||||||||||||||||||||||
MIL_TEXT("FileName") 1 |
Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\MyReportFile.txt"), when the StreamType parameter is set to M_FILE. You should use a TXT file extension. The function handles (internally) the opening and closing of the file. If the file already exists, it will be overwritten. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\MyReportFile.txt"). (summarize)Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\MyReportFile.txt"), when the StreamType parameter is set to M_FILE. (more details...) |
||||||||||||||||||||||||||||||||||||||
MemPtr |
Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type MIL_UINT8. The specified address must correspond to the first memory address in which to write, and the block of memory must be large enough to stream the entire object. To determine the required size, call this function with M_INQUIRE_SIZE_BYTE. Note that when using a C compiler (not a C++ or other compiler), you must cast the MIL_UINT8 pointer to a MIL_TEXT_PTR. (summarize)Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. (more details...) |
||||||||||||||||||||||||||||||||||||||
SysId |
This parameter must be set to M_NULL. (summarize)This parameter must be set to M_NULL. (more details...) |
||||||||||||||||||||||||||||||||||||||
Version |
This parameter must be set to M_DEFAULT. (summarize)This parameter must be set to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ContextImIdPtr |
Specifies the address of the variable containing the identifier of the augmentation result buffer to save. (summarize)Specifies the address of the variable containing the identifier of the augmentation result buffer to save. (more details...) |
1 If you are passing the value in a variable, don't enclose it in MIL_TEXT().
Header | Include mil.h. |
Library | Use mil.lib; milim.lib. |
DLL | Requires mil.dll; milim.dll. |