PvDropTable()
Drops the specified table from the open dictionary specified by the dictionary handle.
Header File: ddf.h (See also
Header Files
)
Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (OS X) (See also
Link Libraries
)
Syntax
PRESULT PvDropTable(
WORD
dictHandle,
LPCSTR
tableName,
WORD
keepFile
);
Arguments
In
dictHandle
Handle of an open dictionary returned by
PvOpenDatabase()
.
In
tableName
Name of the table to delete.
In
keepFile
Indicates whether or not the data file will be deleted. If set to 0, the data file associated with the table will be deleted. If non-zero, the data file will not be deleted.
Return Values
PCM_Success
The operation was successful.
PCM_errFailed
The operation was not successful.
PCM_errInvalidDictionaryHandle
The specified dictionary handle does not exist.
PCM_errTableNotFound
The specified table name was not found.
Remarks
You must first open a dictionary successfully using
PvOpenDatabase()
.
The table specified by
tableName
must exist in the dictionary specified by
dictHandle
.
See Also
PvStart()
PvOpenDatabase()
PvGetTableNames()
PvGetTable()
PvAddTable()
PvCloseDictionary()
PvStop()