Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sdbc ::
interface XStruct
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XStruct
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.

Methods' 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.

Methods' Details
getSQLTypeName
string getSQLTypeName() | raises( | 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
sequence< any > getAttributes( | [in] ::com::sun::star::container::XNameAccess raises( | typeMap ) 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

Copyright © 2003 Sun Microsystems, Inc.