interface XStruct in module com::sun::star::sdbc::

(Global Index)

Syntax

interface XStruct : com::sun::star::uno::XInterface ;

Description

is used for the standard mapping for a SQL structured type.

A Struct object contains a value for each attribute of the SQL structured type that it represents. By default, an instance of Struct is valid as long as the application has a reference to it.

Method Summary

getSQLTypeName retrieves the SQL type name of the SQL structured type that this Struct object represents.

getAttributes produces the ordered values of the attributes of the SQL structured type that this Struct object represents.

Method Details



getSQLTypeName

Syntax

string getSQLTypeName ();
raises ( com::sun::star::sdbc::SQLException );

Description

retrieves the SQL type name of the SQL structured type that this Struct object represents.

Returns

the name of the SQL type.

Throws

SQLException if a database access error occurs.

getAttributes

Syntax

sequence< any > getAttributes (
com::sun::star::container::XNameAccess typeMap )
raises ( com::sun::star::sdbc::SQLException );

Description

produces the ordered values of the attributes of the SQL structured type that this Struct object represents.

This method uses the given type map for customizations of the type mappings. If there is no entry in the given type map that matches or the given type map is NULL , the structured type that this Struct object represents, the driver uses the connection type mapping.

Parameter typeMap

is a map object that contains mappings of SQL type names to services. If the typeMap is NULL , the type-map associated with the connection for customizations of the type-mappings is used.

Returns

an array containing the ordered attribute values.

Throws

SQLException if a database access error occurs.
Top of Page