TripleDES Class

Properties   Methods   Events   Config Settings   Errors  

Encrypt and decrypt data with TripleDES, successor to the DES encryption algorithm.

Syntax

TripleDES

Remarks

The TripleDES component is used to encrypt and decrypt data with TripleDES, successor to the DES encryption algorithm.

To begin simply specify the data you wish to encrypt or decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Before encrypting you must have a valid Key and IV. There are a few options available to you in regards to key management. The easiest option is to simply set KeyPassword. When KeyPassword is set the component will automatically create a Key and IV using the PKCS5 password digest algorithm. This means there is only one value you need to keep track of.

If you wish to have more control over the Key and IV values you may specify the properties yourself. If IV is left empty, one will be created for you when you call Encrypt or Decrypt.

A simple example: Component.InputFile = "C:\MyFile.txt"; Component.OutputFile = "C:\Encrypted.txt"; Component.KeyPassword = "password"; Component.Encrypt();

Note that by default the component uses a key size of 192. You may specify the key size (such as 128 or 168) by setting KeySize.

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.

CipherMode Property (TripleDES Class)

The cipher mode of operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCipherMode();
int SetCipherMode(int iCipherMode);

Unicode (Windows)
INT GetCipherMode();
INT SetCipherMode(INT iCipherMode);

CM_CBC(0), 
CM_ECB(1), 
CM_OFB(2), 
CM_CFB(3), 
CM_CTS(4), 
CM_8OFB(5), 
CM_8CFB(7)

int ipworksencrypt_tripledes_getciphermode(void* lpObj);
int ipworksencrypt_tripledes_setciphermode(void* lpObj, int iCipherMode);

int GetCipherMode();
int SetCipherMode(int iCipherMode);

Default Value

0

Remarks

The cipher mode of operation.

Possible values are:

Data Type

Integer

InputFile Property (TripleDES Class)

The file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworksencrypt_tripledes_getinputfile(void* lpObj);
int ipworksencrypt_tripledes_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

String

InputMessage Property (TripleDES Class)

The message to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage);

Unicode (Windows)
INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);

int ipworksencrypt_tripledes_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_tripledes_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);

QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);

Default Value

""

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

Binary String

IV Property (TripleDES Class)

The initialization vector (IV).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIV(char* &lpIV, int &lenIV);
int SetIV(const char* lpIV, int lenIV);

Unicode (Windows)
INT GetIV(LPSTR &lpIV, INT &lenIV);
INT SetIV(LPCSTR lpIV, INT lenIV);

int ipworksencrypt_tripledes_getiv(void* lpObj, char** lpIV, int* lenIV);
int ipworksencrypt_tripledes_setiv(void* lpObj, const char* lpIV, int lenIV);

QByteArray GetIV();
int SetIV(QByteArray qbaIV);

Default Value

""

Remarks

This property specifies the initialization vector (IV). By default this property is empty and the class will automatically generate a new IV value if KeyPassword or Key is set before Encrypt or EncryptBlock is called. The size of the IV property must be equal to the BlockSize divided by 8.

Data Type

Binary String

Key Property (TripleDES Class)

The secret key for the symmetric algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);
int SetKey(const char* lpKey, int lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);
INT SetKey(LPCSTR lpKey, INT lenKey);

int ipworksencrypt_tripledes_getkey(void* lpObj, char** lpKey, int* lenKey);
int ipworksencrypt_tripledes_setkey(void* lpObj, const char* lpKey, int lenKey);

QByteArray GetKey();
int SetKey(QByteArray qbaKey);

Default Value

""

Remarks

This secret key is used both for encryption and decryption. The secret key should be known only to the sender and the receiver. The legal key size varies depending on the algorithm.

If this property is left empty and KeyPassword is specified, a Key value will be generated by the class as necessary.

Legal Key and Block Sizes (in bits)

Note: When using TEA if Algorithm is set to XXTEA valid block sizes are 64 + n * 32. Where n is any positive integer.

The default KeySize is the Maximum Key Size.

Data Type

Binary String

KeyPassword Property (TripleDES Class)

A password to generate the Key and IV .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyPassword();
int SetKeyPassword(const char* lpszKeyPassword);

Unicode (Windows)
LPWSTR GetKeyPassword();
INT SetKeyPassword(LPCWSTR lpszKeyPassword);

char* ipworksencrypt_tripledes_getkeypassword(void* lpObj);
int ipworksencrypt_tripledes_setkeypassword(void* lpObj, const char* lpszKeyPassword);

QString GetKeyPassword();
int SetKeyPassword(QString qsKeyPassword);

Default Value

""

Remarks

When this property is set the class will calculate values for Key and IV using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

The size of the Key generated is dependent on the value of KeySize.

Data Type

String

OutputFile Property (TripleDES Class)

The output file when encrypting or decrypting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* ipworksencrypt_tripledes_getoutputfile(void* lpObj);
int ipworksencrypt_tripledes_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to Encrypt and Decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Data Type

String

OutputMessage Property (TripleDES Class)

The output message after processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputMessage(char* &lpOutputMessage, int &lenOutputMessage);

Unicode (Windows)
INT GetOutputMessage(LPSTR &lpOutputMessage, INT &lenOutputMessage);

int ipworksencrypt_tripledes_getoutputmessage(void* lpObj, char** lpOutputMessage, int* lenOutputMessage);

QByteArray GetOutputMessage();

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

This property is read-only and not available at design time.

Data Type

Binary String

Overwrite Property (TripleDES Class)

Indicates whether or not the class should overwrite files.

Syntax

• C++
• C
• Qt

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

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

int ipworksencrypt_tripledes_getoverwrite(void* lpObj);
int ipworksencrypt_tripledes_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

PaddingMode Property (TripleDES Class)

The padding mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPaddingMode();
int SetPaddingMode(int iPaddingMode);

Unicode (Windows)
INT GetPaddingMode();
INT SetPaddingMode(INT iPaddingMode);

PM_PKCS7(0), 
PM_ZEROS(1), 
PM_NONE(2), 
PM_ANSIX923(3), 
PM_ISO10126(4)

int ipworksencrypt_tripledes_getpaddingmode(void* lpObj);
int ipworksencrypt_tripledes_setpaddingmode(void* lpObj, int iPaddingMode);

int GetPaddingMode();
int SetPaddingMode(int iPaddingMode);

Default Value

0

Remarks

PaddingMode is used to pad the final input block to guarantee that it is the correct size required for the selected CipherMode. If the input size is a multiple of the cipher's BlockSize, an extra block of padding will be appended to the input. This enables the decrypting agent to know with certainty how many bytes of padding are included. Each mode pads the data differently. Possible values are:

When calling Decrypt the PaddingMode must match the value used when the data was encrypted.

Note: When using a value of 2 (pmNone), unless the length of input is an exact multiple of the cipher's input BlockSize, the final block of plaintext may be lost.

Data Type

Integer

UseHex Property (TripleDES Class)

Whether input or output is hex encoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseHex();
int SetUseHex(int bUseHex);

Unicode (Windows)
BOOL GetUseHex();
INT SetUseHex(BOOL bUseHex);

int ipworksencrypt_tripledes_getusehex(void* lpObj);
int ipworksencrypt_tripledes_setusehex(void* lpObj, int bUseHex);

bool GetUseHex();
int SetUseHex(bool bUseHex);

Default Value

FALSE

Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when Encrypt is called the class will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.

If set to True, when Decrypt is called the class will expect InputMessage or InputFile to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

Data Type

Boolean

Config Method (TripleDES 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* ipworksencrypt_tripledes_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.

Decrypt Method (TripleDES Class)

Decrypts the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();

int ipworksencrypt_tripledes_decrypt(void* lpObj);

int Decrypt();

Remarks

This method will decrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)
• CipherMode
• PaddingMode

Note that CipherMode must be set to the same value used during encryption or the results may be unexpected. If the CipherMode value does not match the value used during encryption the operation may succeed but the decrypted data may not be correct.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

DecryptBlock Method (TripleDES Class)

Decrypts a block and returns the decrypted data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DecryptBlock(const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize = NULL);

Unicode (Windows)
LPSTR DecryptBlock(LPCSTR lpInputBuffer, INT lenInputBuffer, BOOL bLastBlock, LPINT lpSize = NULL);

char* ipworksencrypt_tripledes_decryptblock(void* lpObj, const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize);

QByteArray DecryptBlock(QByteArray qbaInputBuffer, bool bLastBlock);

Remarks

This method will decrypt the specified block and return the decrypted data.

InputBuffer specifies the encrypted block to decrypt.

LastBlock indicates whether the block is the last block.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); 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.

Encrypt Method (TripleDES Class)

Encrypts the data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Encrypt();

Unicode (Windows)
INT Encrypt();

int ipworksencrypt_tripledes_encrypt(void* lpObj);

int Encrypt();

Remarks

This method will encrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)
• PaddingMode
• CipherMode

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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

EncryptBlock Method (TripleDES Class)

Encrypts data and returns the encrypted block.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* EncryptBlock(const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize = NULL);

Unicode (Windows)
LPSTR EncryptBlock(LPCSTR lpInputBuffer, INT lenInputBuffer, BOOL bLastBlock, LPINT lpSize = NULL);

char* ipworksencrypt_tripledes_encryptblock(void* lpObj, const char* lpInputBuffer, int lenInputBuffer, int bLastBlock, int *lpSize);

QByteArray EncryptBlock(QByteArray qbaInputBuffer, bool bLastBlock);

Remarks

This method will encrypt the input data and return the encrypted block.

InputBuffer specifies the input data to encrypt.

LastBlock specifies whether the block is the last block.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); 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.

Reset Method (TripleDES Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksencrypt_tripledes_reset(void* lpObj);

int Reset();

Remarks

When called, the class will reset all of its 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.)

SetInputStream Method (TripleDES Class)

Sets the stream from which the class will read data to encrypt or decrypt.

Syntax

• C++
• C
• Qt

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

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

int ipworksencrypt_tripledes_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);

int SetInputStream(IPWorksEncryptStream* sInputStream);

Remarks

This method sets the stream from which the class will read data to encrypt or decrypt.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 (TripleDES Class)

Sets the stream to which the class will write encrypted or decrypted data.

Syntax

• C++
• C
• Qt

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

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

int ipworksencrypt_tripledes_setoutputstream(void* lpObj, IPWorksEncryptStream* sOutputStream);

int SetOutputStream(IPWorksEncryptStream* sOutputStream);

Remarks

This method sets the stream to which the class will write encrypted or decrypted data.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

• SetInputStream
• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• SetOutputStream
• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

When using streams, you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

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 (TripleDES Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TRIPLEDES_ERROR 1

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

class TripleDESErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass TripleDES and override this emitter function.
virtual int FireError(TripleDESErrorEventParams *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 (TripleDES Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} TripleDESProgressEventParams;


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

typedef struct {
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} TripleDESProgressEventParams;

#define EID_TRIPLEDES_PROGRESS 2

virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed);

class TripleDESProgressEventParams {
public:
  qint64 BytesProcessed();

  int PercentProcessed();

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

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

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

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

IPWorksEncryptStream Type

Syntax

IPWorksEncryptStream (declared in ipworksencrypt.h)

Remarks

The TripleDES 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 IPWorksEncryptStream interface and pass the TripleDES class an instance of that concrete class.

When implementing the IPWorksEncryptStream 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 (TripleDES Class)

TripleDES Config Settings

Base Config Settings

Trappable Errors (TripleDES 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.

TripleDES Errors