Docs

IPWorks 2022 Python Edition

Version 22.0 [Build 8171]

NetCode Class

Properties   Methods   Events   Configuration 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, URL, etc. UUEncode , MIME's Base64 Quoted-Printable , URL encoding formats, as well as secure hash functions such as MD5 and SHA1, are currently supported.

Syntax

class ipworks.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 decoded_data property and the encoded data or filename is specified by the encoded_data property. The file_name property may be used to override the default file names or to specify a directory during uuencoding. After uudecoding, the file_name property contains the fully specified file name of the decoded file.

Understanding Encoding/Decoding

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

Decoding is the inverse process: creation of the original file from the encoded data. Encoded data is 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 config 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 encoded_data 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 encoded_data.

Property List


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

decoded_dataThe decoded data.
decoded_fileThe filename of the decoded data.
encoded_dataThe encoded data.
encoded_fileFilename of the encoded data.
file_cntShows the number of encoded files the class has read from or written into.
file_nameThe destination filename for the encoded data.
formatThe type of encoding to be used.
modeThe UNIX-style filemode when uuencoding / uudecoding.
overwriteControls whether created file(s) should overwrite already existing file(s).
progress_stepControls the granularity at which the Progress event is fired. Values 0-100.

Method List


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

configSets or retrieves a configuration setting.
decodeDecode string.
encodeEncode the data.
resetReset the class.
reset_dataResets the values of all data and stream properties.

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.

on_errorInformation about errors during data delivery.
on_progressOccurs when PercentDone of the input is read.

Configuration Settings


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

Base64LineBreakTells the class whether to include line breaks in Base64 encoded content or not.
EncodeHashWhether the hash value is hex encoded.
HMACAlgorithmThe hash algorithm to use when generating a Hash-based Message Authentication Code (HMAC).
HMACKeyA key to use when generating a Hash-based Message Authentication Code (HMAC).
MaxFileSizeWhen encoding, controls whether encoded data should be split into several files and gives the maximum allowed size for these files.
UseExtendedHexBase32Specifies whether or not the Extended Hex alphabet is used.
UseModifiedUTF7Specifies whether or not a modified form of UTF-7 for IMAP mailbox naming is used.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

decoded_data Property

The decoded data.

Syntax

def get_decoded_data() -> bytes: ...

def set_decoded_data(value: bytes) -> None: ...


decoded_data = property(get_decoded_data, set_decoded_data)

Default Value

""

Remarks

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

decoded_file Property

The filename of the decoded data.

Syntax

def get_decoded_file() -> str: ...

def set_decoded_file(value: str) -> None: ...


decoded_file = property(get_decoded_file, set_decoded_file)

Default Value

""

Remarks

This property contains the filename of the decoded data. When uuencoding, the value of file_name is the filename that will be written in encoded_data. If file_name is empty, the value of the decoded_file property is taken, if a valid file has been specified. It is recommended that encoded_data contains the full path and file_name contains only the file name 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: decoded_file, file_name, or when the format is UUEncode, the specified filename in the uuencoded data itself. If decoded_file or file_name end with a backslash "\" they are interpreted as directories and the class tries to create the given filename in this directory. If this is the case, file_name shows the name of the file that was created.

encoded_data Property

The encoded data.

Syntax

def get_encoded_data() -> bytes: ...

def set_encoded_data(value: bytes) -> None: ...


encoded_data = property(get_encoded_data, set_encoded_data)

Default Value

""

Remarks

This property contains the data that has either been encoded or is set to be decoded.

encoded_file Property

Filename of the encoded data.

Syntax

def get_encoded_file() -> str: ...

def set_encoded_file(value: str) -> None: ...


encoded_file = property(get_encoded_file, set_encoded_file)

Default Value

""

Remarks

This property contains the filename of the encoded data. If the encoded data is spread over several files, the filenames are passed to encoded_file in the form name?. Question marks "?" are expanded to numerals starting with 0. The filenames should exist as path\file000.ext and passed to encoded_file 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. file_cnt contains the number of encoded files.

See also the format property, and the MaxFileSize config setting when working with multiple files.

file_cnt Property

Shows the number of encoded files the class has read from or written into.

Syntax

def get_file_cnt() -> int: ...


file_cnt = property(get_file_cnt, None)

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 encoded_file they will be expanded from 000 to file_cnt - 1 (the number of question marks "?" specifies the number of figures).

Please refer to encoded_file for filename conventions.

This property is read-only.

file_name Property

The destination filename for the encoded data.

Syntax

def get_file_name() -> str: ...

def set_file_name(value: str) -> None: ...


file_name = property(get_file_name, set_file_name)

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 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 give a hint about the reason of the failure.

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

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

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 directory), then trap the error and check the filename appended to this property.

format Property

The type of encoding to be used.

Syntax

def get_format() -> int: ...

def set_format(value: int) -> None: ...


format = property(get_format, set_format)

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:

fmtUUEncode (0)3 Bytes are encoded into 4 readable characters. If multiple filenames are specified, then the extension ".uue" is used/expected.
fmtBase64 (1)Encoding format of MIME. Much like UUEncode but another subset of printable characters is used. If multiple filenames are specified, then the extension ".b64" is used/expected.
fmtQP (2)Quoted-Printable is another MIME format coding only special characters. Mostly used if the text contains special accented characters. If multiple filenames are specified, then the extension ".q_p" is used/expected.
fmtURL (3)Encoding of non-printable, 8-bit or unsafe characters as defined in RFC 1738. (No multiple filenames can be specified with this encoding.)
fmtJIS (4)Japanese Industrial Standards encoding of Japanese character sets.
fmtYEncode (5)Similar to Base64, but uses 8-bit encoding to reduce the amount of data being sent and received. Designed for binaries on the Usenet or Email.
fmtMD5Hash (6)The Message Digest 5 hashing algorithm produces a 128-bit hash output.
fmtSHA1Hash (7)The Secure Hash Algorithm produces a 128-bit hash output.
fmtHex (8)Creates a hexadecimal string representation of the decoded data.
fmtHTML (9)Creates an HTML-encoded string.
fmtHMAC (10)Creates a Hash-based Message Authentication Code for the given data. To set the key, use HMACKey. To set the hash algorithm to use to create the MAC, use HMACAlgorithm.
fmtUTF8 (11)Convert strings to/from UTF-8 to the current code page (Windows only).
fmtUTF7 (12)Convert strings to/from UTF-7 to the current code page (Windows only).
fmtBase32 (13)Similar to Base64, but uses 32 printable characters. If multiple filenames are specified, then the extension ".b32" is used/expected.
fmtBase64URL (14)Base64 encoding for use within URLs. The "+" character is replaced with "-". The "/" character is replaced with "_". The padding character "=" is omitted.
fmtSHA256 (15)The Secure Hash Algorithm 2 produces a 256-bit hash output.
fmtPunycode (16)Convert string to/from Punycode. The CodePage configuration setting must be set to a value capable of interpreting the non-ASCII character data being encoded/decoded. For instance 65001. In addition the C++ Edition on Windows requires use of the NetCodeW class which supports wide chars.

mode Property

The UNIX-style filemode when uuencoding / uudecoding.

Syntax

def get_mode() -> str: ...

def set_mode(value: str) -> None: ...


mode = property(get_mode, set_mode)

Default Value

"0755"

Remarks

This property contains the UNIX-style filemode when uuencoding / 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.

Given for compatibility with other systems. Used only when format is fmtUUE.

overwrite Property

Controls whether created file(s) should overwrite already existing file(s).

Syntax

def get_overwrite() -> bool: ...

def set_overwrite(value: bool) -> None: ...


overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property controls whether created file(s) should overwrite already existing file(s). Note that more than one file may be created during uuencoding.

progress_step Property

Controls the granularity at which the Progress event is fired. Values 0-100.

Syntax

def get_progress_step() -> int: ...

def set_progress_step(value: int) -> None: ...


progress_step = property(get_progress_step, set_progress_step)

Default Value

1

Remarks

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

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

decode Method

Decode string.

Syntax

def decode() -> None: ...

Remarks

This method decodes according to the format type. The class will decode the data in the input stream if set_input_stream 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 encoded_file property. If no valid file has been specified, the class will use the encoded_data property.

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

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

When YDecoding, the source path and filename is specified in encoded_file and the destination path and filename in decoded_file. If the encoded data indicates the name of the original file before decoding, this value will be stored in the file_name property. To decode a multi-part message, all parts must be concatenated in order in the source file.

encode Method

Encode the data.

Syntax

def encode() -> None: ...

Remarks

This method encodes the data according to the format type. The class will encode the data in the input stream if set_input_stream 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 decoded_file property. If no valid file has been specified, the class will use the decoded_data property.

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

The data is 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 file_name property.

The current version of NetCode creates no 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 encoded_file and MaxFileSize is set and the encoded data takes more space than MaxFileSize, the data is split over several files. In this case, the user can specify more than one filename by passing them to encoded_file 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.

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

reset_data Method

Resets the values of all data and stream properties.

Syntax

def reset_data() -> None: ...

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.

on_error Event

Information about errors during data delivery.

Syntax

class NetCodeErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class NetCode:
@property
def on_error() -> Callable[[NetCodeErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[NetCodeErrorEventParams], None]) -> None: ...

Remarks

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

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

on_progress Event

Occurs when PercentDone of the input is read.

Syntax

class NetCodeProgressEventParams(object):
  @property
  def percent_done() -> int: ...

# In class NetCode:
@property
def on_progress() -> Callable[[NetCodeProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[NetCodeProgressEventParams], None]) -> None: ...

Remarks

The progress_step property determines how often the event is fired.

NetCode Configuration

The class accepts one or more of the following configuration settings. Configuration 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.

NetCode Configuration Settings

Base64LineBreak:   Tells the class whether to include line breaks in Base64 encoded content or not.

By default, when encoding to Base64 format, the component will insert line breaks every 76 characters. Setting the Base64LineBreak config to false will cause these line breaks to be omitted from the Base64 encoded content. The default value is true.

EncodeHash:   Whether the hash value is hex encoded.

This setting determines whether the MD5, SHA1, or SHA256 hash value is hex encoded. When calling encode if this setting is True (default) the hash value created will be hex encoded. When set to False the output will not be hex encoded and will be binary. This is only applicable to the following formats:

  • MD5
  • SHA1
  • SHA256

HMACAlgorithm:   The hash algorithm to use when generating a Hash-based Message Authentication Code (HMAC).

HMACAlgorithm is used to tell the class which hashing algorithm to use to generate the Hash-based Message Authentication Code (HMAC). HMACAlgorithm can be "SHA1" (Secure Hash Algorithm 1), "MD5" (Message Digest 5), or one of the SHA-2 algorithms mentioned below. You may truncate the hash output by specifying the desired number of bits. For instance "SHA1-96" and "MD5-96" are acceptable.

The component is capable utilizing the set of HMAC SHA-2 algorithms ("SHA-224", "SHA-256", "SHA-384", and "SHA-512").

The component also supports "RIPEMD160" as an HMAC algorithm.

HMACKey:   A key to use when generating a Hash-based Message Authentication Code (HMAC).

When using the format fmtHMAC, it may be necessary to supply the class with a key to use when generating the Hash-based Message Authentication Code (HMAC). This key is incorporated into the hashing process to add entropy to the resulting hash code, making the plaintext harder to guess and increasing the message security. You may also set this to a hex value. For instance 0xAAAAAA is acceptable.

MaxFileSize:   When encoding, controls whether encoded data should be split into several files and gives the maximum allowed size for these files.

Some mailing systems require that the message size shouldn't exceed a certain size. Assigning a nonzero value to MaxFileSize makes the class split the encoded data into several files. file_cnt will contain the number of files created. Please refer to encoded_file for filename conventions.

The default value for this setting is 0 (no limit).

IMPORTANT: if a non-zero value is assigned to MaxFileSize then a multiple filename should also be assigned to encoded_file (end with question marks "?") so that the class can expand the filenames.

Please refer to the Error Codes section for a complete list of possible errors.

UseExtendedHexBase32:   Specifies whether or not the Extended Hex alphabet is used.

When format is set to fmtBase32, UseExtendedHexBase32 is used to tell the class whether or not to use the Extended Hex alphabet. The default value is False.

UseModifiedUTF7:   Specifies whether or not a modified form of UTF-7 for IMAP mailbox naming is used.

When format is set to fmtUTF7, UseModifiedUTF7 is used to tell the class whether or not to use a modified version of UTF-7 for IMAP mailbox naming. The default value is False.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

NetCode Errors

NetCode Errors

1   Short uuencoded file.
2   The closing `end' was not found (uudecoded file may be too short).
3   Can't create the file for write (illegal name or disk is write-protected).
4   Can't open the file for read (doesn't exist?).
5   Can't read from file.
6   Can't write to file (disk full?).
7   Please supply a filename for uuencoded data.
8   File exists and overwrite was set to False.
9   There's not enough space in output string.
10   The given filenames are insufficient to split all the encoded data.
11   Please supply a filename for the encoded data.
12   Encoded data can't be written in more than 100 files.
13   Couldn't write to file. Permission denied.
14   Couldn't write to file. Disk full.
15   Too many open files. No more file handles are available, so no more files can be opened.
16   The given filename doesn't exist.
17   There are no more files to read from or write to.
18   The starting 'begin' was not found. Is it uuencoded data?
19   The current format is not supported.
20   The specified stream does not support Available().
21   Format error when YDecoding.
22   No '=yend' found when YDecoding.
23   Escape character found at end of line when YDecoding.
24   CRC check failed when YDecoding (Corrupt data).
25   Output buffer length was not calculated.
26   Invalid character in base64 data.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 Python Edition - Version 22.0 [Build 8171]