IMStream::Modify
The IMStream::Modify method modifies stream settings.
The stream data is written to memory until it reaches a threshold and then it is written to a file. The created file can be temporary or explicit. A temporary file can be created in the system temp directory or in a specified one. If both the fileName and dir are empty strings or null, a temporary file is created in the system's temp dir. If only the fileName is empty (null), a temporary file is created in the specified directory. If the fileName is specified, dir is ignored.
Quick info
HRESULT Modify(long lMaxMem, BSTR bstrDirectory, BSTR bstrFileName,
VARIANT_BOOL bKeepFile) Parameters
- lMaxMem
- [in] - threshold size for stream. After the stream exceeds this size, it will begin to be flushed to file.
- bstrDirectory
- [in] - directory in which to create the temporary file
- bstrFileName
- [in] - explicit file name path
- bKeepFile
- [in] - If it is true, the file is preserved after the stream is destroyed. If it is false, the file is deleted.
Return values
The
following value is returned when this method is called:
- S_OK
- Success status