Developer Reference

  • 0.9
  • 09/09/2020
  • Public Content
Contents

vslSaveStreamF

Writes random stream descriptive data, including stream state, to binary file.

Syntax

errstatus
=
vslSaveStreamF
(
stream
,
fname
);
Include Files
  • mkl.h
Input Parameters
Name
Type
Description
stream
const VSLStreamStatePtr
Random stream to be written to the file
fname
const char*
File name specified as a null-terminated string
Output Parameters
Name
Type
Description
errstatus
int
Error status of the operation
Description
The
vslSaveStreamF
function writes the random stream descriptive data, including the stream state, to the binary file. Random stream descriptive data is saved to the binary file with the name
fname
. The random stream
stream
must be a valid stream created by
vslNewStream
-like or
vslCopyStream
-like service routines. If the stream cannot be saved to the file,
errstatus
has a non-zero value. The random stream can be read from the binary file using the
vslLoadStreamF
function.
Return Values
VSL_ERROR_OK, VSL_STATUS_OK
Indicates no error, execution is successful.
VSL_ERROR_NULL_PTR
Either
fname
or
stream
is a
NULL
pointer.
VSL_RNG_ERROR_BAD_STREAM
stream
is not a valid random stream.
VSL_RNG_ERROR_FILE_OPEN
Indicates an error in opening the file.
VSL_RNG_ERROR_FILE_WRITE
Indicates an error in writing the file.
VSL_RNG_ERROR_FILE_CLOSE
Indicates an error in closing the file.
VSL_ERROR_MEM_FAILURE
System cannot allocate memory for internal needs.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804