# TK_URL

## Functions

| `TK_URL`
| `~TK_URL`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetString`
void | `SetString`
char const * | `GetString`
char * | `GetString`

## Detailed Description

class TK_URL : public BBaseOpcodeHandler

  Handles the TKE_URL opcodes.

  TK_URL provides 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).

  Public Functions

  inline TK_URL()

    constructor

  ~TK_URL()
  virtual TK_Status Read(BStreamFileToolkit &tk)

    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 the BStreamFileToolkit object.

    Returns

      The result of the function call.

  virtual TK_Status Write(BStreamFileToolkit &tk)

    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 the BStreamFileToolkit object.

    Returns

      The result of the function call.

  virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

    Copies the opcode handler

    Parameters

      - tk – A reference to the BStreamFileToolkit object.

      - handler – A pointer to the opcode handler object. Passed by reference.

    Returns

      The result of the function call.

  TK_Status ReadAscii(BStreamFileToolkit &tk)

    Deprecated.

  TK_Status WriteAscii(BStreamFileToolkit &tk)

    Deprecated.

  virtual void Reset()

    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 SetString(char const *string)

    Sets the reference string. Allocates the buffer and copies the string

  void SetString(int length)

    Sets the reference string buffer. Allocates a buffer large enough to hold a string of ‘length’ bytes

  inline char const *GetString() const

    Returns the reference string

  inline char *GetString()

    Returns the reference string buffer, which may be modified directly