 | CDB Methods |
The CDB type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddAssociatedLoad | Add this channel to the auto-load feature of the group. |
| AddComment | Add a comment with a string to the activity log of the database. |
| AddIntComment | Add a comment with an integer to the activity log of the database. |
| AddRealComment | Add a comment with a float value to the activity log of the database. |
| AddTimeComment | Add a comment with the date and time to the activity log of the database. |
| ArrayLST | Load a LST object with array (VA) channel symbols. |
| ArraySizeLST | Load a LST object with array (VA) channel symbols with a particular number of columns. |
| Associate | Associate a channel with a group. |
| AssociateAll | Associate all channels with a group. |
| AssociateClass | Associate a channel with all groups of a specific class. |
| ChanLST | Load a LST with database channels. |
| ClassChanLST | Load a LST with channels in a particular class. |
| ClassGroupLST | Load a LST with group lines in a particular class. |
| Commit | This method forces all changes to the database to be saved. |
| Compact |
Removes any extra space from the database. This will
reduce the database to its smallest size.
|
| CopyData |
This method copies the data from one channel to another on
on the specified line. The data is converted if such
conversion in neccessary.
|
 | Create |
This method makes a brand new database of the specified size.
The database is opened in ReadWrite Mode.
|
| CreateComp |
This method makes a brand new database of the specified size.
The database is opened in ReadWrite Mode. Also allows you to
set paging size and the Compression Level.
|
| CreateDup |
This method makes a brand new database identical to the input
Database in-size.
The database is opened in ReadWrite Mode.
|
| CreateDupComp |
This method makes a brand new database identical to the input
Database in-size except it changes the compression.
The database is opened in ReadWrite Mode.
|
| CreateEx |
This method makes a brand new database of the specified size.
The database is opened in ReadWrite Mode. Also allows you to
set paging size.
|
| CreateSymb | Create a new Symbol. |
| CreateSymbEx | Create a new Symbol. |
| CreateSymbLST | Create a LST object large enough to contain channel names and symbols numbers. |
| CSVChanLST | Load a LST with channels in a comma-separated list. |
| DeleteSymb |
This method destroys a symbol in the database and all
the data associated with it. The symbol's lock is
automatically removed.
|
| DelLine0 | Delete Empty Line 0. |
| Discard |
This method discards all changes made to the database since
the last commit or opening.
|
 | Dispose | (Overrides CHANDLEDispose(Boolean).) |
| DupLineSymb |
Duplicate a line symbol from a group or line symbol.
The new name must not already exist in the database.
|
| DupSymb | New Symbol by duplicating an existing symbol, LOCKED |
| DupSymbAcross |
Create a new Symbol by duplicating an existing symbol.
exactly the same type but in output database. The symbol must
not already exist in the output database.
|
| DupSymbNoLock | New Symbol by duplicating an existing symbol, NO LOCK. |
| EasyMakerSymb | Adds a Maker to the database symbol based on current GX |
| FindChan | Get handle to the specified channel. |
| FindSymb | Get handle to the specified symbol. |
| FirstSelLine |
This method will return a handle to the first selected
line in the database.
|
| GenValidChanSymb(CGXNETCore, String, String) | Generate a valid channel name from a name candidate |
| GenValidChanSymb(CGXNETCore, String, String, Int32) | Generate a valid channel name from a name candidate |
| GenValidLineSymb(CGXNETCore, String, String) | Generate a valid line symb name string from given string. |
| GenValidLineSymb(CGXNETCore, String, String, Int32) | Generate a valid line symb name string from given string. |
| GetChanOrderLST |
This method gets the channel display order for a
database. The list will be stored in an LST object.
In order to modify this displayed channels list,
call SetChanOrderLST_DB after.
|
| GetChanStr(Int32, Int32, Int32, String) | Get individual elements in a channel. |
| GetChanStr(Int32, Int32, Int32, String, Int32) | Get individual elements in a channel. |
| GetChanVA | Place the contents of a channel in a VA. |
| GetChanVV | Place the contents of a channel in a VV. |
| GetChanVVExpanded |
Read a channel into a VV. If the channel is a VA channel it is
treaded as a VV channel with multiple values per fid and the FID expation
is set to the array size.
|
| GetIPJ | Get georeference information in an IPJ. |
| GetITR | Get ITR for a channel. |
| GetLineMapFid | This method gets a line map clip fiducial. |
| GetMETA | Get the metadata of a database. |
| GetRegSymb | Get a REG object from a symbol |
| GetRegSymbSetting(Int32, String, String) | Get a REG string setting from a symbol reg |
| GetRegSymbSetting(Int32, String, String, Int32) | Get a REG string setting from a symbol reg |
| GetSelect | Gets the Line Selections. |
| GetVABaseCoordinateInfo(Int32, Int32, Double, CVV, String) | Set the array channel base coordinate type, offset and values. |
| GetVABaseCoordinateInfo(Int32, Int32, Double, CVV, String, Int32) | Set the array channel base coordinate type, offset and values. |
| GetVaChanVV | Place the contents of a specific part of a channel in a VV. |
| GetVAScaling | Get base and range for VA channel cell display. |
| GetVAWindows | Get the range of windows displayed for a VA channel. |
| GetXYZChanSymb | Searches for current X, Y or Z channel symbol |
| Grow | Enlarges the database. |
| iBlobsMax | Gets Maximum Number of Blobs in the Database |
| iCanOpen | This method checks whether it is possible to open a database. |
| iCanOpenReadOnly | This method checks whether it is possible to open a database in read-only mode. |
| iChansMax | Gets Maximum Number of Channels in the Database |
| iCheck |
Does an integrity check of the data in the database to
ensure it is valid.
|
| iClassChanList | Place a list of channels for a given class in a VV. |
| iCountSelLines |
This method counts the number of selected lines in
the database.
|
| iExistChan | See if the specified channel exists in the database. |
| iExistSymb |
This method checks to see if the specified symbol exists
in the database.
|
| IFormatChan(Int32, Double, String) | Format a real value based on a channel format. |
| IFormatChan(Int32, Double, String, Int32) | Format a real value based on a channel format. |
| iGetChanArraySize |
This method Gets a channel's array size for a
given channel handle.
|
| IGetChanClass(Int32, String) | This method gets a channel's label |
| IGetChanClass(Int32, String, Int32) | This method gets a channel's label |
| iGetChanDecimal |
This method gets a channel's number of digits displayed
to the right of the decimal point.
|
| iGetChanFormat |
This method Gets a channel's display format for a
given channel handle.
|
| iGetChanInt | Get individual elements in a channel. |
| IGetChanLabel(Int32, String) | This method gets a channel's label |
| IGetChanLabel(Int32, String, Int32) | This method gets a channel's label |
| IGetChanName(Int32, String) |
This method Gets a channel's name for a
given channel handle.
|
| IGetChanName(Int32, String, Int32) |
This method Gets a channel's name for a
given channel handle.
|
| iGetChannelLength | Returns the # of elements in a channel. |
| iGetChanProtect | This method gets a channel's read-only protection status. |
| iGetChanType |
This method Gets a channel's type for a
given channel handle.
|
| IGetChanUnit(Int32, String) | This method Gets a channel's unit |
| IGetChanUnit(Int32, String, Int32) | This method Gets a channel's unit |
| iGetChanWidth |
This method gets a channel's display width for a
given channel handle.
|
| iGetColVA | Returns the # of columns in a VA channel. |
| IGetGroupClass(Int32, String) | Set the Class name for a group line. |
| IGetGroupClass(Int32, String, Int32) | Set the Class name for a group line. |
| iGetInfo | Get information about the database. |
| iGetLineSelection | Get the selection status for a line. |
| iGetModificationCount | Gets the modification count from the database. |
| IGetName(Int32, String) | Gets a name from the database. |
| IGetName(Int32, String, Int32) | Gets a name from the database. |
| iGetRegSymbSetting | Get an integer-valued REG setting from a symbol reg |
| iGetSymbLock | Determines if a symbol is locked |
| IGetSymbName(Int32, String) | This method gets a symbol's name |
| IGetSymbName(Int32, String, Int32) | This method gets a symbol's name |
| IGetVAProfColorFile(Int32, String) | Get colors for a VA channel when displayed in the profile window. |
| IGetVAProfColorFile(Int32, String, Int32) | Get colors for a VA channel when displayed in the profile window. |
| IGetVAProfSectOption(Int32, String) | Get the display options of VA channels |
| IGetVAProfSectOption(Int32, String, Int32) | Get the display options of VA channels |
| IGetVASectColorFile(Int32, String) | Get colors for a VA channel when displayed section in the profile window. |
| IGetVASectColorFile(Int32, String, Int32) | Get colors for a VA channel when displayed section in the profile window. |
| IGetXYZChan(Int32, String) | Gets current X, Y or Z channel name |
| IGetXYZChan(Int32, String, Int32) | Gets current X, Y or Z channel name |
| iHaveITR | Returns TRUE if channel has an ITR. |
| IiCoordPair(String, String) | Get the matching coordinate pair of a channel. |
| IiCoordPair(String, String, Int32) | Get the matching coordinate pair of a channel. |
| iIsAssociated | Check to see if a channel is associated with group. |
| iIsChanName | Is this a valid channel name? |
| iIsChanValid |
This method checks to see if the channel handle is a
valid channel.
|
| iIsEmpty | See if a database contains only empty lines. |
| iIsLineEmpty | See if a specific line in the database is empty. |
| iIsLineName | Is this a valid line name. |
| iIsLineValid |
This method checks to see if the line handle returned by
the Line methods is a valid line.
|
| iIsWholeplot | Is this a Wholeplot database? |
| iLineCategory | This method returns the category (group, line) of a line. |
| iLineFlight | This method returns the flight number of a line. |
| ILineLabel(Int32, String, Int32) | Create a line label |
| ILineLabel(Int32, String, Int32, Int32) | Create a line label |
| iLineNumber | This method returns the number of a line. |
| ILineNumber2(Int32, String) | Returns the string form of the line number (can be alphanumeric) |
| ILineNumber2(Int32, String, Int32) | Returns the string form of the line number (can be alphanumeric) |
| iLinesMax | Gets Maximum number of lines in the database |
| iLineType | This method returns the type of a line. |
| iLineVersion | This method returns the version number of a line. |
| ISetLineName(CGXNETCore, Int32, Int32, Int32, String) |
This method sets up a line name given the line's number,
type, and version.
|
| ISetLineName(CGXNETCore, Int32, Int32, Int32, String, Int32) |
This method sets up a line name given the line's number,
type, and version.
|
| ISetLineName2(CGXNETCore, String, Int32, Int32, String) | Like SetLineName_DB, but can use alphanumeric for line number |
| ISetLineName2(CGXNETCore, String, Int32, Int32, String, Int32) | Like SetLineName_DB, but can use alphanumeric for line number |
| iSymbList | Place a list of symbols in a VV. |
| iUsersMax | Gets Maximum number of Users |
| iValidSymb | This method checks to see if the specified symbol is a valid symbol in the database. |
| LineLST | Load a LST with database lines. |
| LoadSelect | Load selections to from a file. |
| LockSymb | Locks a symbol for READONLY or READWRITE. |
| MakerSymb | Adds a Maker to the database symbol |
| MaskChanLST | Load a LST with mask channels. |
| NextSelLine |
This method will advance to the next selected line based
on the currently selected line handle.
|
| NonStringAndNonArrayChanLST | Load a LST with non-string and non-array database channels. |
| NormalChanLST | Load a LST with non-array database channels. |
| Open | This method opens a database. |
| OpenReadOnly | This method opens a database. |
| PutChanVA | Place the contents of a VA in a channel. |
| PutChanVV | Place the contents of a VV in a channel. |
| PutVaChanVV | Place the contents of a VV at a specific part of a channel. |
| ReadBlobBF | Read a blob from a database into a file. |
| RenameLine | Change the name for a line. |
| Repair | Cleans the database by removing invalid blocks |
| rGetChanReal | Get individual elements in a channel. |
| rGetFidIncr |
This method returns the fiducial increment value of a
specified Channel.
|
| rGetFidStart |
This method returns the fiducial start value of a
specified Channel.
|
| rGetRegSymbSetting | Get a real-valued REG setting from a symbol reg |
| rLineBearing | This method returns the bearing of a line. |
| rLineDate | This method returns the date of a line. |
| SaveSelect | Saves current selections to a file. |
| Select | Select/deselect lines based on selection string |
| SelectedLineLST | Load a LST with the selected lines. |
| SetAllChanProtect | This method sets all the channels' read-only protection status. |
| SetChanClass | Set a channel class |
| SetChanDecimal |
This method sets a channel's number of digits displayed
to the right of the decimal point.
|
| SetChanFormat | This method sets a channel's display format. |
| SetChanInt | Set individual elements in a channel. |
| SetChanLabel | Set a channel label |
| SetChanName | This method sets a channel's name. |
| SetChanOrderLST |
This method sets the channel display order for a
database. The list to modify will be stored in an LST
object. Call GetChanOrderLST_DB to populate the LST.
|
| SetChanProtect |
This method sets a channel's read-only protection
status.
|
| SetChanReal | Set individual elements in a channel. |
| SetChanStr | Set individual elements in a channel. |
| SetChanUnit |
This method sets a channel's unit for a
given channel handle.
|
| SetChanWidth | This method sets a channel's display width |
| SetFid |
This method allows the user to set the fiducial start and
increment of a channel. The Increment should never be 0.
|
| SetGroupClass | Set the Class name for a group line. |
| SetIPJ | Set an IPJ object into a pair of (X, Y) channels |
| SetITR | Set ITR for a channel. |
| SetLineBearing | Sets a line's bearing. |
| SetLineDate | This method sets a line's date. |
| SetLineFlight | This method sets a line's flight. |
| SetLineMapFid | This method changes a line map clip fiducial. |
| SetLineNum | This method sets a line's number. |
| SetLineSelection | Set the selection status for a line. |
| SetLineType | This method sets a line's type. |
| SetLineVer | This method sets a line's version. |
| SetMETA | Set the metadata of a database. |
| SetRegSymb | Set a REG object into a symbol |
| SetRegSymbSetting | Set a REG string setting in a symbol reg |
| SetSelect | Sets the Line Selections. |
| SetVABaseCoordinateInfo | Set the array channel base coordinate type, offset and values. |
| SetVAProfColorFile | Set colors for a VA channel when displayed in the profile window. |
| SetVAProfSectOption | Set the display options of VA channels |
| SetVAScaling | Set base and range for VA channel cell display. |
| SetVASectColorFile | Set colors for a VA channel when displayed section in the profile window. |
| SetVAWindows | Set the range of windows to display for a VA channel. |
| SetXYZChan | Sets current X, Y or Z channel name |
| StringChanLST | Load a LST with string-type channels. |
| SymbLST | Populate a LST with database symbols. |
| Sync | Syncronize the Metadata from this database to the XML |
| UnLockAllSymb | UnLocks all symbols. |
| UnLockSymb | UnLocks a symbol. |
| WindowVACh | Copy a window of data in a channel into a new channel |
| WindowVACh2 | Copy a windowed version of data in a channel into a new channel |
| WriteBlobBF | Write a blob from a file into a database. |
See Also