Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

TK_Read_Stream_File

Functions

TK_Status BBINFILETK_API TK_Read_Stream_File (char const *filename, BStreamFileToolkit *tk)
 Reads a HOOPS Stream File. More...
 
TK_Status BBINFILETK_API TK_Read_Stream_File (char const *filename, int flags=0)
 Reads a HOOPS Stream File. More...
 
TK_Status BBINFILETK_API TK_Read_Stream_File (__wchar_t const *filename, BStreamFileToolkit *tk)
 
TK_Status BBINFILETK_API TK_Read_Stream_File (__wchar_t const *filename, int flags=0)
 
TK_Status BBINFILETK_API TK_Read_Stream_File (char const *filename, int flags, BStreamFileToolkit *tk)
 Deprecated; reads a HOOPS Stream File More...
 

Detailed Description

Function Documentation

TK_Status BBINFILETK_API TK_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
filenameA character pointer denoting the name of the file to read in.
tkA pointer to the BStreamFileToolkit to 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 the BStreamFileToolkit::SetReadFlags() method on the toolkit.
TK_Status BBINFILETK_API TK_Read_Stream_File ( char const *  filename,
int  flags = 0 
)

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
filenameA character pointer denoting the name of the file to read in.
flagsBitwise encoding of options which control how the file is read. TK_File_Read_Options provides a list of supported options.
TK_Status BBINFILETK_API TK_Read_Stream_File ( __wchar_t const *  filename,
BStreamFileToolkit tk 
)

wide character variant of the standard version of TK_Read_Stream_File

TK_Status BBINFILETK_API TK_Read_Stream_File ( __wchar_t const *  filename,
int  flags = 0 
)

wide character variant of the standard version of TK_Read_Stream_File

TK_Status BBINFILETK_API TK_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.