getClientInfo Method (java.lang.String)

  • Article

Retrieves the value of a specified client information property.

Note

This feature is introduced starting with the Microsoft SQL Server JDBC Driver version 2.0

public java.lang.String getClientInfo (java.lang.String name)

Parameters

name

A String that contains the name of the client information property to retrieve.

Return Value

A String that contains the value of the client information property.

Exceptions

SQLServerException

Remarks

This getClientInfo method is specified by the getClientInfo method in the java.sql.Connection interface.

The Microsoft SQL Server JDBC Driver version 2.0 does not support any client info properties. As a result, in the JDBC Driver version 2.0 release, this method returns null.

Similarly, applications can use the getClientInfoProperties method of the SQLServerDatabaseMetaData class to retrieve a list of the client information properties that the driver supports. In the JDBC Driver version 2.0 release, the getClientInfoProperties method returns an empty result set.

See Also

Reference

SQLServerConnection Class

Concepts

getClientInfo Method (SQLServerConnection)
SQLServerConnection Methods
SQLServerConnection Members