NetCode Class

Properties   Methods   Events   Config Settings   Errors  

The NetCode class can be used to encode or decode files or strings using a variety of popular encoding formats, such as Base64, UUencode, and URL. UUEncode , MIME's Base64 Quoted-Printable , and URL encoding formats, as well as secure hash functions such as MD5 and SHA1, are currently supported.

Syntax

NetCode

Remarks

The encoding format is specified by the Format property. The binary data, or the name of the file containing binary data, is specified by the DecodedData property and the encoded data or filename is specified by the EncodedData property. The FileName property may be used to override the default file names or to specify a directory during uuencoding. After uudecoding, the FileName property contains the fully specified file name of the decoded file.

Understanding Encoding/Decoding

Most mail systems use only 7 bits to transmit messages. A binary file, such as an archive or a non-plaintext-formatted file produced from a text processor should be first encoded in 7-bit code before email transfer.

Decoding is the inverse process (i.e., creation of the original file from the encoded data). Encoded data are often split over several files because of the size limit placed on the email message. Each message is preceded by information about this splitting, as well as the mail header. NetCode supports this case in both directions:

- During encoding, setting the MaxFileSize configuration setting to the maximum size of a message body instructs NetCode to split the encoded data over several files. Multiple filenames can be specified by using question marks "?" (see the EncodedData property for more information).

- During decoding, the body messages can be saved in separate files named namexxx.ext, where xxx is a numeral starting at 000 and ext is ".uue", ".b16", or ".q_p" according to Format. These multiple filenames should be given to EncodedData.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

DecodedData Property (NetCode Class)

This property includes the decoded data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecodedData(char* &lpDecodedData, int &lenDecodedData);
int SetDecodedData(const char* lpDecodedData, int lenDecodedData);

Unicode (Windows)
INT GetDecodedData(LPSTR &lpDecodedData, INT &lenDecodedData);
INT SetDecodedData(LPCSTR lpDecodedData, INT lenDecodedData);

int ipworks_netcode_getdecodeddata(void* lpObj, char** lpDecodedData, int* lenDecodedData);
int ipworks_netcode_setdecodeddata(void* lpObj, const char* lpDecodedData, int lenDecodedData);

QByteArray GetDecodedData();
int SetDecodedData(QByteArray qbaDecodedData);

Default Value

""

Remarks

This property contains the decoded data. When uuencoding, the value of FileName is the filename that will be written in EncodedData. If FileName is empty, an error will be returned.

This property is not available at design time.

Data Type

Binary String

DecodedFile Property (NetCode Class)

This property includes the filename of the decoded data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecodedFile();
int SetDecodedFile(const char* lpszDecodedFile);

Unicode (Windows)
LPWSTR GetDecodedFile();
INT SetDecodedFile(LPCWSTR lpszDecodedFile);

char* ipworks_netcode_getdecodedfile(void* lpObj);
int ipworks_netcode_setdecodedfile(void* lpObj, const char* lpszDecodedFile);

QString GetDecodedFile();
int SetDecodedFile(QString qsDecodedFile);

Default Value

""

Remarks

This property contains the filename of the decoded data. When uuencoding, the value of FileName is the filename that will be written in EncodedData. If FileName is empty, the value of the DecodedFile property is taken, if a valid file has been specified. It is recommended that EncodedData contains the full path and that FileName contains only the filename so that no problems occur while uudecoding in a foreign system.

When decoding, the class tries to generate the name for the created file in the following order: DecodedFile, FileName, or when the format is UUEncode, the specified filename in the uuencoded data. If DecodedFile or FileName end with a backslash "\" they are interpreted as directories, and the class will try to create the given filename in this directory. If this is the case, FileName shows the name of the file that was created.

Data Type

String

EncodedData Property (NetCode Class)

This property includes the encoded data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncodedData(char* &lpEncodedData, int &lenEncodedData);
int SetEncodedData(const char* lpEncodedData, int lenEncodedData);

Unicode (Windows)
INT GetEncodedData(LPSTR &lpEncodedData, INT &lenEncodedData);
INT SetEncodedData(LPCSTR lpEncodedData, INT lenEncodedData);

int ipworks_netcode_getencodeddata(void* lpObj, char** lpEncodedData, int* lenEncodedData);
int ipworks_netcode_setencodeddata(void* lpObj, const char* lpEncodedData, int lenEncodedData);

QByteArray GetEncodedData();
int SetEncodedData(QByteArray qbaEncodedData);

Default Value

""

Remarks

This property contains the data that either have been encoded or are set to be decoded.

This property is not available at design time.

Data Type

Binary String

EncodedFile Property (NetCode Class)

This property includes the filename of the encoded data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncodedFile();
int SetEncodedFile(const char* lpszEncodedFile);

Unicode (Windows)
LPWSTR GetEncodedFile();
INT SetEncodedFile(LPCWSTR lpszEncodedFile);

char* ipworks_netcode_getencodedfile(void* lpObj);
int ipworks_netcode_setencodedfile(void* lpObj, const char* lpszEncodedFile);

QString GetEncodedFile();
int SetEncodedFile(QString qsEncodedFile);

Default Value

""

Remarks

This property contains the filename of the encoded data. If the encoded data are spread over several files, the filenames are passed to EncodedFile in the form name?. Question marks "?" are expanded to numerals starting with 0. The filenames should exist as path\file000.ext and are passed to EncodedFile in the form name???. Question marks "?" are expanded to numerals starting with 000 (the number of zeros "0" equals that of question marks "?").

The class appends the extension ".uue", ".b16", or ".q_p" depending on Format immediately after the generated numbers. FileCnt contains the number of encoded files.

See also the Format property, and the MaxFileSize configuration setting when working with multiple files.

Data Type

String

FileCnt Property (NetCode Class)

This property shows the number of encoded files the class has read from or written into.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileCnt();

Unicode (Windows)
INT GetFileCnt();

int ipworks_netcode_getfilecnt(void* lpObj);

int GetFileCnt();

Default Value

0

Remarks

This property shows the number of encoded files the class has read from or written into. If the user specifies one or more questions marks "?" in EncodedFile, they will be expanded from 000 to FileCnt - 1 (the number of question marks "?" specifies the number of figures).

Please refer to EncodedFile for filename conventions.

This property is read-only.

Data Type

Integer

FileName Property (NetCode Class)

This property includes the destination filename for the encoded data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFileName();
int SetFileName(const char* lpszFileName);

Unicode (Windows)
LPWSTR GetFileName();
INT SetFileName(LPCWSTR lpszFileName);

char* ipworks_netcode_getfilename(void* lpObj);
int ipworks_netcode_setfilename(void* lpObj, const char* lpszFileName);

QString GetFileName();
int SetFileName(QString qsFileName);

Default Value

""

Remarks

This property contains the destination filename for the encoded data. When uuencoding, this property contains the filename that is specified in the uuencoded data.

When decoding, if the value of the property is not empty, it shows the class where to write the decoded data. It can be either the filename or the directory where the file should be written. If is should be written to a directory, it should end with a backslash "\".

After a decode operation, this property contains the filename for the created file. If the file couldn't be created because of an illegal filename, examining this property might provide a hint about the reason of the failure.

This property must be set to "" (empty string) after each decode operation because it contains the full specification of the file.

An error occurs if a uuencoding operation is initiated with an empty FileName.

If you want to first check the uuencoded filename before creating it on disk, you may assign an illegal directory name to this property (always use a closing backslash "\" to denote it as a directory), then trap the error and check the filename appended to this property.

Data Type

String

Format Property (NetCode Class)

This property includes the type of encoding to be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFormat();
int SetFormat(int iFormat);

Unicode (Windows)
INT GetFormat();
INT SetFormat(INT iFormat);

FMT_UUENCODE(0), 
FMT_BASE_64(1), 
FMT_QP(2), 
FMT_URL(3), 
FMT_JIS(4), 
FMT_YENCODE(5), 
FMT_MD5HASH(6), 
FMT_SHA1HASH(7), 
FMT_HEX(8), 
FMT_HTML(9), 
FMT_HMAC(10), 
FMT_UTF8(11), 
FMT_UTF7(12), 
FMT_BASE_32(13), 
FMT_BASE_64URL(14), 
FMT_SHA256HASH(15), 
FMT_PUNYCODE(16)

int ipworks_netcode_getformat(void* lpObj);
int ipworks_netcode_setformat(void* lpObj, int iFormat);

int GetFormat();
int SetFormat(int iFormat);

Default Value

0

Remarks

This property contains the type of encoding to be used. The following are the possible values for this property, and the corresponding descriptions:

Data Type

Integer

Mode Property (NetCode Class)

This property includes the UNIX-style filemode when uuencoding and uudecoding.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMode();
int SetMode(const char* lpszMode);

Unicode (Windows)
LPWSTR GetMode();
INT SetMode(LPCWSTR lpszMode);

char* ipworks_netcode_getmode(void* lpObj);
int ipworks_netcode_setmode(void* lpObj, const char* lpszMode);

QString GetMode();
int SetMode(QString qsMode);

Default Value

"0755"

Remarks

This property contains the UNIX-style filemode when uuencoding and uudecoding. The filemode is usually an octal number, such as 755 or 600, which gives the protections of that file. If the file to uudecode is correctly read, then this property contains the protection string given in the uuencoded data.

This is given for compatibility with other systems and is used only when Format is fmtUUE.

Data Type

String

Overwrite Property (NetCode Class)

This property controls whether created file(s) should overwrite already existing file(s).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworks_netcode_getoverwrite(void* lpObj);
int ipworks_netcode_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property controls whether created file(s) should overwrite already existing file(s).

Note: More than one file may be created during uuencoding.

Data Type

Boolean

ProgressStep Property (NetCode Class)

This property controls the granularity at which the Progress event is fired. Values are 0-100.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProgressStep();
int SetProgressStep(int iProgressStep);

Unicode (Windows)
INT GetProgressStep();
INT SetProgressStep(INT iProgressStep);

int ipworks_netcode_getprogressstep(void* lpObj);
int ipworks_netcode_setprogressstep(void* lpObj, int iProgressStep);

int GetProgressStep();
int SetProgressStep(int iProgressStep);

Default Value

1

Remarks

This property controls the granularity at which the Progress event is fired. Values are 0-100. If this property is not 0, the Progress event will be fired when 0%, n* ProgressStep and 100% of input data are read.

If this property is 0, the Progress event is disabled.

Data Type

Integer

Config Method (NetCode Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_netcode_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Decode Method (NetCode Class)

This method decodes a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decode();

Unicode (Windows)
INT Decode();

int ipworks_netcode_decode(void* lpObj);

int Decode();

Remarks

This method decodes according to the Format type. The class will decode the data in the input stream if SetInputStream has been set to a valid stream. If this stream is null, the class will then try to read the data from the file set by the EncodedFile property. If no valid file has been specified, the class will use the EncodedData property.

The resulting decoded data are written to the output stream if one has been set. If not, the component will attempt to write the decoded data to the DecodedFile. If no file was specified, the decoded data may be retrieved through the DecodedData property.

When UUDecoding the created filename will by default be the one specified in the uuencoded data. The FileName property will contain this value. DecodedFile or, if DecodedFile is empty, FileName can be used to override this value.

When YDecoding, the source path and filename is specified in EncodedFile and the destination path and filename in DecodedFile. If the encoded data indicate the name of the original file before decoding, this value will be stored in the FileName property. To decode a multipart message, all parts must be concatenated in order in the source file.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Encode Method (NetCode Class)

This method encodes the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encode();

Unicode (Windows)
INT Encode();

int ipworks_netcode_encode(void* lpObj);

int Encode();

Remarks

This method encodes the data according to the Format type. The class will encode the data in the input stream if SetInputStream has been set to a valid stream. If this stream is null, the class will then try to read the data from the file set by the DecodedFile property. If no valid file has been specified, the class will use the DecodedData property.

The resulting encoded data are written to the output stream if one has been set. If not, the component will attempt to write the encoded data to the EncodedFile. If no file was specified, the encoded data may be retrieved through the EncodedData property.

The data are considered binary while uuencoding and Base64 Formats, and text during QuotedPrintable ones.

When uuencoding or yencoding, the filename encoded into the data is taken from the FileName property.

The current version of NetCode does not create message headers. If a MIME standard encoding is used, such as Base64 Encoding or Quoted Printable Encoding, the user should fill the header values appropriately.

If EncodedFile and MaxFileSize is set and the encoded data take more space than MaxFileSize, the data are split over several files. In this case, the user can specify more than one filename by passing them to EncodedFile in the form name?. The filenames should exist as path\file0.ext, path\file1.ext ... Question marks "?" are expanded to numerals starting with 0. NetCode appends the extension ".uue", ".b16", or ".q_p" (depending on the value of Format) to the filename.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (NetCode Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_netcode_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResetData Method (NetCode Class)

This method resets the values of all data and stream properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetData();

Unicode (Windows)
INT ResetData();

int ipworks_netcode_resetdata(void* lpObj);

int ResetData();

Remarks

This method resets the values of all data and stream properties. It is an easy way to reset the class's properties before another call to Encode or Decode. The input and output streams and the data and file properties will all be reset.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (NetCode Class)

This method sets the input stream of data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(IPWorksStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksStream* sInputStream);

int ipworks_netcode_setinputstream(void* lpObj, IPWorksStream* sInputStream);

int SetInputStream(IPWorksStream* sInputStream);

Remarks

Use this method to set the input stream of data for the component to read from. If Encode or Decode is called, and this is not null, the data will be read from this stream when the specified action occurs. You may reset this by calling ResetData.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetOutputStream Method (NetCode Class)

This method sets the output stream of data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(IPWorksStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(IPWorksStream* sOutputStream);

int ipworks_netcode_setoutputstream(void* lpObj, IPWorksStream* sOutputStream);

int SetOutputStream(IPWorksStream* sOutputStream);

Remarks

Use this method to set the output stream of data for the component to write. If Encode or Decode is called, and this is not null, the data will be written to this stream when the specified action occurs. You may reset this by calling ResetData.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (NetCode Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(NetCodeErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} NetCodeErrorEventParams;


Unicode (Windows)
virtual INT FireError(NetCodeErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} NetCodeErrorEventParams;

#define EID_NETCODE_ERROR 1

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class NetCodeErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(NetCodeErrorEventParams *e);

// Or, subclass NetCode and override this emitter function.
virtual int FireError(NetCodeErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (NetCode Class)

This event occurs when PercentDone of the input is read.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(NetCodeProgressEventParams *e);

typedef struct {
  int PercentDone;
  int reserved;
} NetCodeProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(NetCodeProgressEventParams *e);

typedef struct {
  INT PercentDone;
  INT reserved;
} NetCodeProgressEventParams;

#define EID_NETCODE_PROGRESS 2

virtual INT IPWORKS_CALL FireProgress(INT &iPercentDone);

class NetCodeProgressEventParams {
public:
  int PercentDone();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(NetCodeProgressEventParams *e);

// Or, subclass NetCode and override this emitter function.
virtual int FireProgress(NetCodeProgressEventParams *e) {...}

Remarks

The ProgressStep property determines how often the event is fired.

IPWorksStream Type

Syntax

IPWorksStream (declared in ipworks.h)

Remarks

The NetCode class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksStream interface and pass the NetCode class an instance of that concrete class.

When implementing the IPWorksStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (NetCode Class)

NetCode Config Settings

Base Config Settings

Trappable Errors (NetCode Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

NetCode Errors