ApsySuffix (Imagine property)

From m204wiki
Jump to navigation Jump to search

ApsySuffix: Return the APSY suffix character for the current connection

The ApsySuffix method returns the APSY suffix character for the current Imagine connection as a String.

If no suffix is active (the port does not have APSYSUFFIX defined, or the broker did not send a suffix), an empty string is returned.

This is a shared, read-only method.

Syntax

%suffix = %(imagineObject):ApsySuffix

Return value

A String containing the single-character APSY suffix (A-Z, 0-9) for the current connection, or an empty string if no suffix is active.

Usage

Use ApsySuffix to determine which suffix the connecting broker presented during the handshake. This is useful in APSY code that needs to vary its behavior based on which DBS instance the connection is targeting.

This is new as of Model 204 version 8.0.

Example

%suffix = %(system):ApsySuffix If %suffix NE Then Print 'Suffix: ' %suffix End If

See also