LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XAlterTable Interface Referencepublished

is used for creating and appending new objects to a specific container. More...

import"XAlterTable.idl";

Inheritance diagram for XAlterTable:
XInterface Table Table

Public Member Functions

void alterColumnByName ([in]string colName, [in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException, com::sun::star::container::NoSuchElementException)
 is intended to alter an existing column identified by its name. More...
 
void alterColumnByIndex ([in]long index, [in]com::sun::star::beans::XPropertySet descriptor) raises (com::sun::star::sdbc::SQLException, com::sun::star::lang::IndexOutOfBoundsException)
 is intended to alter an existing column identified by its position. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

is used for creating and appending new objects to a specific container.

Member Function Documentation

◆ alterColumnByIndex()

void alterColumnByIndex ( [in] long  index,
[in] com::sun::star::beans::XPropertySet  descriptor 
)
raises (com::sun::star::sdbc::SQLException,
com::sun::star::lang::IndexOutOfBoundsException
)

is intended to alter an existing column identified by its position.

This operation must be atomic, in that it is done in one step.s

Parameters
indexthe position of the column to alter
descriptorthe new descriptor for the new column
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.
com::sun::star::lang::IndexOutOfBoundsExceptionif the given index does not denote an existing column.

◆ alterColumnByName()

void alterColumnByName ( [in] string  colName,
[in] com::sun::star::beans::XPropertySet  descriptor 
)
raises (com::sun::star::sdbc::SQLException,
com::sun::star::container::NoSuchElementException
)

is intended to alter an existing column identified by its name.

This operation must be atomic, in that it is done in one step.s

Parameters
colNamethe column name which to alter
descriptorthe new descriptor for the new column
Exceptions
com::sun::star::sdbc::SQLExceptionif a database access error occurs.

The documentation for this interface was generated from the following file: