MDAC 2.5 SDK - OLE DB Programmer's Reference
OLE DB Interfaces

IAlterTable::AlterTable

Alters the ID and/or properties associated with a table.

HRESULT AlterTable(
   DBID *      pTableID,
   DBID *      pNewTableID,
   ULONG       cPropertySets,
   DBPROPSET   rgPropertySets[]);

Parameters

pTableID

[in]
The DBID of the base table to alter.

pNewTableID

[in]
The new DBID of the base table. If this is the same as pTableID or is a null pointer, the ID of the table is unchanged.

cPropertySets

[in]
The number of DBPROPSET structures in rgPropertySets. If this is zero, the provider ignores rgPropertySets.

rgPropertySets

[in/out]
An array of DBPROPSET structures containing properties and values to be set. The properties specified in these structures must belong to the table property set.

Return Code

S_OK

The method succeeded.

DB_S_ERRORSOCCURRED

The table was altered, but one or more properties—for which the dwOptions element of the DBPROP structure was DBPROPOPTIONS_OPTIONAL—were not set. The consumer checks dwStatus in the DBPROP structures to determine which properties were not set. The method can fail to set properties for a number of reasons, including:

• The property was not supported by the provider.
  
  
• The property was not in the Table property group.
  
  
• The property set was not supported by the provider.
  
  
• It was not possible to set the property.
  
  
• colid in the DBPROP structure was not DB_NULLID.
  
  
• The data type in vValue in the DBPROP structure was not the data type of the property or was not VT_EMPTY.
  
  
• The value in vValue in the DBPROP structure was invalid.
  
  
• The property's value conflicted with an existing property.

E_FAIL

A provider-specific error occurred.

E_INVALIDARG

pTableID was a null pointer.

cPropertySets was not zero and rgPropertySets was a null pointer.

In an element of rgPropertySets, cProperties was not zero and rgProperties was a null pointer.

DB_E_BADTABLEID

*pTableID or *pNewTableID was an invalid table ID.

DB_E_ERRORSOCCURRED

The table was not altered because one or more properties—for which the dwOptions element of the DBPROP structure was DBPROPOPTIONS_REQUIRED or an invalid value—could not be set. The consumer checks dwStatus in the DBPROP structures to determine which properties were not set. The method can fail to set properties for any of the reasons specified in DB_S_ERRORSOCCURRED.

DB_E_NOTABLE

The table specified in *pTableID does not exist in the data store.

DB_DUPLICATETABLEID

The table specified in *pNewTableID already exists in the data store.

DB_SEC_E_PERMISSIONDENIED

The consumer did not have sufficient permission to alter the table or index.

DB_E_TABLEINUSE

The specified table was in use, and the provider could not alter the table while it was open.

Comments

IAlterTable::AlterTable applies the new properties and table ID to the existing table. The altered table preserves all properties associated with the existing table that are not explicitly changed by properties specified in rgPropertySets. If pNewTableID is null or the same as pTableID, the table ID is unchanged. If cPropertySets is zero, no properties are changed. If pNewTableID is null or the same as pTableID and if cPropertySets is zero, the method makes no change to the state of the table and returns S_OK.