TK_URL
-
class
TK_URL Handles the TKE_URL opcodes.
TK_URLprovides support for writing/reading the TKE_URL opcode object to/from an HSF file.An URL in a stream file is another form of user/application data. Its intent is to provide informational links corresponding to data (as opposed to External_Reference which provides additional content).
Inherits from:
BBaseOpcodeHandlerIndex
Methods
Clone()GetString()GetString()Read()ReadAscii()Reset()SetString()SetString()TK_URL()Write()WriteAscii()~TK_URL()
Variables
Methods
-
TK_Status
TK_URL::Read(BStreamFileToolkit &tk) virtual
Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available
GetData()methods.Parameters
tk: A reference to theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_URL::Write(BStreamFileToolkit &tk) virtual
Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available
PutData()methods, and first write out the opcode associated with the group of binary data followed by the data itself.Parameters
tk: A reference to theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_URL::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_URL::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_URL::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_URL::Reset() virtual
Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.
-
void
TK_URL::SetString(char const *string) Sets the reference string. Allocates the buffer and copies the string
-
void
TK_URL::SetString(int length) Sets the reference string buffer. Allocates a buffer large enough to hold a string of ‘length’ bytes
Variables