rtxIntDecode.h File Reference

General purpose integer decode functions. More...

#include "rtxsrc/rtxContext.h"

Go to the source code of this file.

Functions
EXTERNRT int	rtxDecInt8 (OSCTXT *pctxt, OSINT8 *pvalue)
	This macro decodes an 8-bit signed integer at the current message buffer/stream location and advances the pointer to the next field. More...
EXTERNRT int	rtxDecInt16 (OSCTXT *pctxt, OSINT16 *pvalue, OSSIZE nbytes)
	This function decodes an 16-bit signed integer at the current message buffer/stream location and advances the pointer to the next field. More...
EXTERNRT int	rtxDecInt32 (OSCTXT *pctxt, OSINT32 *pvalue, OSSIZE nbytes)
	This function decodes an 32-bit signed integer at the current message buffer/stream location and advances the pointer to the next field. More...
EXTERNRT int	rtxDecInt64 (OSCTXT *pctxt, OSINT64 *pvalue, OSSIZE nbytes)
	This function decodes an 64-bit signed integer at the current message buffer/stream location and advances the pointer to the next field. More...
EXTERNRT int	rtxDecUInt8 (OSCTXT *pctxt, OSUINT8 *pvalue)
	This macro decodes an 8-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field. More...
EXTERNRT int	rtxDecUInt16 (OSCTXT *pctxt, OSUINT16 *pvalue, OSSIZE nbytes)
	This function decodes an 16-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field. More...
EXTERNRT int	rtxDecUInt32 (OSCTXT *pctxt, OSUINT32 *pvalue, OSSIZE nbytes)
	This function decodes an 32-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field. More...
EXTERNRT int	rtxDecUInt64 (OSCTXT *pctxt, OSUINT64 *pvalue, OSSIZE nbytes)
	This function decodes a 64-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field. More...

Detailed Description

General purpose integer decode functions.

These decode integer value contents that are encoded in big-endian form. This is a common format for a number of different encoding rules.

Definition in file rtxIntDecode.h.

Function Documentation

rtxDecInt16()

EXTERNRT int rtxDecInt16	(	OSCTXT *	pctxt,
		OSINT16 *	pvalue,
		OSSIZE	nbytes
	)

This function decodes an 16-bit signed integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to receive decoded 16-bit integer value. Pass null to discard the decoded value.
nbytes	Number of bytes to decode (2 or less).

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.

rtxDecInt32()

EXTERNRT int rtxDecInt32	(	OSCTXT *	pctxt,
		OSINT32 *	pvalue,
		OSSIZE	nbytes
	)

This function decodes an 32-bit signed integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to receive decoded 32-bit integer value. Pass null to discard the decoded value.
nbytes	Number of bytes to decode (4 or less).

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.

rtxDecInt64()

EXTERNRT int rtxDecInt64	(	OSCTXT *	pctxt,
		OSINT64 *	pvalue,
		OSSIZE	nbytes
	)

This function decodes an 64-bit signed integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to receive decoded 64-bit integer value. Pass null to discard the decoded value.
nbytes	Number of bytes to decode (8 or less).

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.

rtxDecInt8()

EXTERNRT int rtxDecInt8	(	OSCTXT *	pctxt,
		OSINT8 *	pvalue
	)

This macro decodes an 8-bit signed integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to decoded 8-bit integer value.

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.

rtxDecUInt16()

EXTERNRT int rtxDecUInt16	(	OSCTXT *	pctxt,
		OSUINT16 *	pvalue,
		OSSIZE	nbytes
	)

This function decodes an 16-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to decoded 16-bit integer value.
nbytes	Number of bytes to decode (2 or less).

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.

rtxDecUInt32()

EXTERNRT int rtxDecUInt32	(	OSCTXT *	pctxt,
		OSUINT32 *	pvalue,
		OSSIZE	nbytes
	)

This function decodes an 32-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to decoded 32-bit integer value.
nbytes	Number of bytes to decode (4 or less).

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.

rtxDecUInt64()

EXTERNRT int rtxDecUInt64	(	OSCTXT *	pctxt,
		OSUINT64 *	pvalue,
		OSSIZE	nbytes
	)

This function decodes a 64-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to decoded 64-bit integer value.
nbytes	Number of bytes to decode (8 or less).

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.

rtxDecUInt8()

EXTERNRT int rtxDecUInt8	(	OSCTXT *	pctxt,
		OSUINT8 *	pvalue
	)

This macro decodes an 8-bit unsigned integer at the current message buffer/stream location and advances the pointer to the next field.

Parameters

pctxt	Pointer to context block structure.
pvalue	Pointer to decoded 8-bit integer value.

Returns

Completion status of operation:

• 0 (0) = success,
• negative return value is error.