Function libCZI_CreateOutputStreamForFileWide

Function libCZI_CreateOutputStreamForFileWide#

Function Documentation#

LibCZIApiErrorCode libCZI_CreateOutputStreamForFileWide(const wchar_t *filename, bool overwrite, OutputStreamObjectHandle *output_stream_object)#

Create an output stream object for a file identified by its filename, which is given as a wide string. Note that wchar_t on Windows is 16-bit wide, and on Unix-like systems it is 32-bit wide.

Parameters:

  • filename – Filename of the file which is to be opened (zero terminated wide string). Note that on Windows, this is a string with 16-bit code units, and on Unix-like systems it is typically a string with 32-bit code units.

  • overwrite – Indicates whether the file should be overwritten.

  • output_stream_object – [out] The output stream object that will hold the created stream.

Returns:

An error-code that indicates whether the operation is successful or not. Non-positive values indicates successful, positive values indicates unsuccessful operation.

Contents