Functions
-
TK_Status BBINFILETK_API TK_Read_Stream_File(char const *filename, BStreamFileToolkit *tk) TK_StatusTK_Read_Stream_File(char const filename,BStreamFileToolkit* tk)Reads a HOOPS Stream File.
The contents of the HOOPS Stream File are read in. Opcodes are handled via either the default handlers registered with the toolkit, or using the custom handlers which have been registered by the developer. Typically, the HSF data is mapped to application data structures within the custom opcode handler’s Execute method.
Parameters
filename: A character pointer denoting the name of the file to read in.
tk: A pointer to the
BStreamFileToolkitto use as a basis for reading the file. This would be passed in to read in a customized file that contains user-specified data. Options to control how the file is read may be specified using theBStreamFileToolkit::SetReadFlags()method on the toolkit.
-
TK_Status
TK_Read_Stream_File(char const *filename, int flags = 0) TK_StatusTK_Read_Stream_File(char const filename, int flags)Reads a HOOPS Stream File.
The contents of the HOOPS Stream File are read in. Opcodes are handled via either the default handlers registered with the toolkit, or using the custom handlers which have been registered by the developer. Typically, the HSF data is mapped to application data structures within the custom opcode handler’s Execute method.
Parameters
filename: A character pointer denoting the name of the file to read in.
flags: Bitwise encoding of options which control how the file is read.
TK_File_Read_Optionsprovides a list of supported options.
-
TK_Status
TK_Read_Stream_File(__wchar_t const *filename, BStreamFileToolkit *tk) TK_StatusTK_Read_Stream_File(__wchar_t const filename,BStreamFileToolkit* tk)wide character variant of the standard version of TK_Read_Stream_File
-
TK_Status
TK_Read_Stream_File(__wchar_t const *filename, int flags = 0) TK_StatusTK_Read_Stream_File(__wchar_t const filename, int flags)wide character variant of the standard version of TK_Read_Stream_File
-
TK_Status
TK_Read_Stream_File(char const *filename, int flags, BStreamFileToolkit *tk) TK_StatusTK_Read_Stream_File(char const filename, int flags,BStreamFileToolkit* tk)Deprecated; reads a HOOPS Stream File
The contents of the HOOPS Stream File are read in. Opcodes are handled via either the default handlers registered with the toolkit, or using the custom handlers which have been registered by the developer. Typically, the HSF data is mapped to application data structures within the custom opcode handler’s Execute method. This form of the function is provided for backward compatibility.