rtxStreamHexText.h File Reference

#include "rtxsrc/osSysTypes.h"
#include "rtxsrc/rtxExternDefs.h"
#include "rtxsrc/rtxStream.h"

Go to the source code of this file.

Functions

EXTERNRT int rtxStreamHexTextAttach (OSCTXT *pctxt, OSUINT16 flags)
 This function initializes a hexText stream and attaches it to the existing stream defined within the context.

Detailed Description

Definition in file rtxStreamHexText.h.


Function Documentation

EXTERNRT int rtxStreamHexTextAttach ( OSCTXT pctxt,
OSUINT16  flags 
)

This function initializes a hexText stream and attaches it to the existing stream defined within the context.

This type of stream object can only be used with an existing stream. It acts as a filter to perform conversion to/from hex characters to binary data.

Parameters:
pctxt Pointer to context structure variable.
flags Specifies the access mode for the stream:

  • OSRTSTRMF_INPUT = input (reading) stream;
  • OSRTSTRMF_OUTPUT = output (writing) stream.
Returns:
Completion status of operation: 0 (0) = success, negative return value is error.