PreviousDTI Programmer's Guide (v10) Next

PvGetTable()

Chapter contents

Returns table attributes for a given table.

Header file: DDF.H
Requires: W3DBAV75.DLL or higher version

Syntax

PRESULT PvGetTable( 
	WORD            dictHandle, 
	LPSTR           tableName, 
	TABLEINFO**     tableProps, 
	COLUMNMAP**     columnList, 
	WORD*           columnCount, 
	INDEXMAP**      indexList, 
	WORD*           indexCount); 

Arguments

In
dictHandle
Handle of an open dictionary returned by PvOpenDictionary().
In
tableName
Name of table to retrieve.
Out
tableProps
Structure containing table information.
Out
columnList
Array of columns defined in the table.
Out
columnCount
Number of columns in columnList.
Out
indexList
Array of segments defined in the table.

Return Values

PCM_Success
The operation was successful.
PCM_errFailed
A general failure occurred
PCM_errMemoryAllocation
Error during memory allocation
PCM_errInvalidDictionaryHandle
The specified dictionary handle does not exist.

Remarks

You must first open a dictionary successfully using PvOpenDictionary().

TableProps, indexList, and columnList arrays will need to be released using PvFreeTable.

See Also

PvStart()
PvOpenDictionary()
PvGetTableNames()
PvFreeTable()
PvFreeTableNames()
PvCloseDictionary()
PvStop()


Chapter contents
Book contents

Prev topic: PvGetStringValueSize()
Next topic: PvGetTableNames()