DH_SetTransmitFormat

DH_SetTransmitFormat — sets client-to-DataHub transmissions to binary or ASCII.

Syntax

#include <cogent.h>

int DH_SetTransmitFormat(int msgformat);

Arguments

msgformat

One of these:

PT_FMT_ASCIIConstructs a humanly readable ASCII string (the default).
PT_FMT_BINARYEncodes data as a raw binary representation, efficient for parsing.
PT_FMT_HEXEncodes data as ASCII encoded hex. This is not a valuable format since it is more difficult to parse and less space efficient than binary, and it is more difficult for humans to read than regular ASCII.

Returns

ST_OK on success, ST_ERROR on failure, or some other value of ST_STATUS.

Description

This function sets a global variable that determines whether DH_WritePoint will attempt to use binary or ASCII format in transmissions from a client to the Cascade DataHub. It instructs the API to transmit all point change messages from the custom client to the DataHub using the specified message format.

See Also

DH_SetReceiveFormat