CONNECTION_EXTENDED_PROPERTY function [String]

CONNECTION_EXTENDED_PROPERTY( 
{ property-id | property-name }
[, property-specific-argument [, connection-id ] ]
)

property-id The connection property ID.
property-name The connection property name. Possible property names are CharSet and NcharCharSet.
property-specific-argument Optional property-specific string parameter associated with the following connection properties.
- CharSet Returns the CHAR character set label for the connection as it is known by the specified standard. The possible values include: ASE, IANA, MIME, JAVA, WINDOWS, UTR22, IBM, and ICU. The default is IANA unless the database connection was made through TDS in which case ASE is the default.
- NcharCharSet Returns the NCHAR character set label for the connection as it is known by the specified standard. The possible values are the same as listed above for CharSet.
connection-id The connection ID number of a database connection. The ID number for the current connection is used if a value is not specified.

Returns extended connection properties. The returned value is a VARCHAR.

The CONNECTION_EXTENDED_PROPERTY function is similar to the CONNECTION_PROPERTY function except that it allows an optional property-specific string parameter to be specified. The interpretation of the property-specific argument depends on the property ID or name specified in the first argument.

You can use the CONNECTION_EXTENDED_PROPERTY function to return the value for any connection property. However, extended information is only available for the extended properties.

SQL/2008 Vendor extension.

The following example returns the CHAR character set of the current connection as it is known by the Java standard:

SELECT CONNECTION_EXTENDED_PROPERTY( 'charset', 'Java' );

CONNECTION_EXTENDED_PROPERTY function [String]

Syntax

Parameters

Returns

Remarks

See also

Standards and compatibility

Example