Skip to main content
Version: 4.2.5

Common data types

The following data types are common for all object groups.

ParamTypeFilepath​

A string containing a path to a disk file.

DirectoryPath​

A string containing a path to a directory.

ParamTypeBool​

Enumerations for boolean values.

Values​

False_ValueValue: 0
True_ValueValue: 1

ParamTypePassword​

A string containing a password.

ParamTypeStringCharacter​

A string containing only one character.

SASLMechanism​

A string containing the name of an SASL mechanism.

StructureXMLSchemaName​

A string containing a name of an XML schema imported into iCore developer.

StructureXMLSchema DocumentName​

A string containing a name of an XML document type imported into iCore developer.

XMLNamespaceURI​

A string containing an xml URI.

XMLNodeName​

A string containing an xml node name.

XMLAttributeName​

A string containing an xml attribute name.

XMLFilter​

A string containing a xml filter.

XMLPrefix​

A string containing a xml prefix.

CharsetName​

A string a character set name (encoding).
See Codepage identifiers for a table of possible values.

RegExpString​

A string containing a regular expression.

See also Regular expression syntax.

ParamTypeComponent​

A string containing the name of a iCore Component.

ParamTypeNode​

An integer containing a Node Identity.

CodePageID​

An integer containing a code page identifier.

See Codepage identifiers for a list of the encodings and their associated code pages.

WSMQ CCSID​

An IBM coded character set identifier.

See WSMQ CCSID Identifiers for a list of supported values.

ComponentGUID​

A string containing a GUID for an iCore Component.

QueueFormatName​

A string containing the format name of a MSMQ-queue. The format name contains the information MSMQ needs to connect to a queue.

Format names​

Three types of format names are supported:

PUBLIC
PUBLIC=QueueGUID

PRIVATE
PRIVATE=ComputerGUID\QueueNumber

DIRECT
DIRECT=AddressSpecification\QueueName (For public queues)
DIRECT=AddressSpecification\PRIVATE$\QueueName (For private queues)

Address specifications​

TCP
Connection-oriented TCP over IP.
Network adress: Internet address notation (IP address).

SPX
Connection-oriented SPX over IPX.
Network adress: Network number and host number (separated by the ":" character).

OS
Connection using the native computer-naming convention.
Network adress: Any computer name supported by the underlying operating system. For Microsoft® Windows NT® version 4.0, it is either the UNC or DNS name (see the examples for public and private queues).

HTTP
HTTP transport.

Network adress:IP address or full DNS name (computer name within an enterprise) followed by the virtual directory name separated by a slash.

HTTPS
Secure HTTP transport through a Secure Sockets Layer (SSL) connection.

Network adress: IP address or full DNS name (computer name within an enterprise) followed by the virtual directory name separated by a slash.|

DateTimeString​

A string containing date and/or time. The format is normally specified by the method, property or function where the type is used, otherwise any data/time format is valid.

UNCServerName​

A string containing the name of a server (machine name).

ParamTypeSetting​

A string containing a setting name.

ParamTypeSettingAttribGroup​

A string containing the name of a setting attribute group.

ParamTypeSettingAttrib​

A string containing the name of a setting attribute.

URLType​

A string containing a URL. Examples:

HTTP://Server/process
FTP://ftpserver/directory/file.txt
FILE://fileserver/directory/file.txt

Some methods and properties might not support all of the URL schemes.

CryptStoreNameType​

A string containing the name of a Certificate store.

ParamTypePosition​

Position specifier type.

Values:

  • PosFirst = 0
  • PosIndex = 1
  • PosLast = -1|

eFileSaveOptions​

SaveCreateNotExist = 1
Creates a new file if the file does not already exist.

SaveCreateOverWrite = 2
Overwrites the file if the file already exists.

eWaitReturnStatus​

Wait return status code is returned by functions and methods that wait for some type of external event, for example a message on a queue or the creation of a file.

Success = 0
Wait operation succeeded. Normally this code means that the data you are waiting for, if any, is available.

PrepareSystemShutdown = 1
Wait operation returned because the system is starting to shut down.

SystemShutdown = 2
Wait operation returned because the system is shutting down.

WaitTimeout = 3
Wait operation timed out. Normally this code means that the data you are waiting for, if any, was not available.

WaitError = 4
There was an error during the wait operation.

Last updated on