GoldMine Application Programming Interface Specification and Reference
Download 465.93 Kb.
|
- Navigate this page:
- GMPassword This is a string property that contains the password used to login to GoldMine. This is a write only property. SQLUserName
- Login This method Loads the BDE (if it has not already been loaded), and logs the user in using the properties as they have been set. Logout
- Count This returns the number of Name/Value pairs in the container. _NewEnum
- Remove Removes the pair specified by the name. Methods Item
- Count Returns the number of values in this N/V Pair. Name
- Append Adds a new record, and returns the new record ID Replace
- Read Reads the contents of the specified field at the current position Top
- Seek Positions to the first record matching the seek value Skip
- Range Activates the index in a table, and set a range of values to limit the scope of data that GoldMine will search RecNo
PropertiesSystemFolderThis is a string property that contains the location of the LICENSE.DBF file. This property maps to the Goldmine API szSysDir parameter in the call to GMW_LoadBDE. GoldmineFolderThis is a string property that contains the location of the CAL.DBF file This property maps to the Goldmine API szGoldDir parameter in the call to GMW_LoadBDE. CommonFolderThis is a string property that contains either the location of CONTACT1.DBF, or the BDE alias used to access the database. For example, to access SQL Server, an alias of MSSQL_Goldmine might be configured. The string to access this would be “MSSQL: MSSQL_GoldMine: dbo:”. GMUserNameThis is a string property that contains the user name to be used to login to GoldMine. All GoldMine user ids are all upper case, so the GMApplication object will convert this property to uppercase when a login occurs. GMPasswordThis is a string property that contains the password used to login to GoldMine. This is a write only property. SQLUserNameThis is a string property that contains the SQL Server user id if the underlying database is SQL server. SQLPasswordThis is a string property that contains the password for the SQL server account used if the database is SQL server. This is a write only property. LicenseInfoThis is an object containing all the license information for the current installation. MethodsLoginThis method Loads the BDE (if it has not already been loaded), and logs the user in using the properties as they have been set. LogoutThis method logs out the logged in user. NewContainerThis method creates a new blank Name/Value pair container object, and returns it. ExecuteThis method takes as parameters a Business Logic Function name (eg “WriteContact”) and a Container object containing the Name/Value pairs for the transaction. It then executes the transaction, and updates the pairs in the container with the results. NewWorkAreaCreates a new work area on the specified table. The Container class. This class cannot be created directly, but should always be created using the NewContainer method on the GMApplication class. This class supports collection semantics to enable the client access to the Name/Value pairs stored internally. By behaving like a collection, the Container is simple to use for developers used to the Collection paradigm so prevalent in the VBA/VB/VBS world. The general scenario for use of a Container would be to Create the container, Add a number of Name/Value pairs, Execute a transaction, Read the results out of the Container. PropertiesCountThis returns the number of Name/Value pairs in the container. _NewEnumThis property is hidden from VB clients. It returns an enumerator into the collection. This can be used from VB using the For Each object in Collection syntax. C++ clients will use this interface as an IEnumVARIANT* to do the enumeration. AddAdds a new entry to the collection. The Add method takes a Name and a Value as parameters, and creates a new NVPair, which it returns. The Value is an optional parameter which defaults to an empty string. If an empty string is passed for the value (or if the optional parameter is left out), the pair is created with no value. This is useful for creating multi value pairs. RemoveRemoves the pair specified by the name. MethodsItemThis method is the default method for the class. It takes a name as a parameter, and returns the name value pair that corresponds to that name. CopyFromConverts this container into a copy of the container passed in. CopyMakes a copy of this container and returns it. The Name/Value Pair Class This class encapsulates a single name/value pair. Because a Name/Value pair could have multiple values, this class is modeled as a collection of strings, where each string represents a single value. Because the Item method is the default method, and the default parameter is 1, VB clients will see the first entry in the collection as the Value of the object. When a GMNVPair object is created using the Add method on the container the pair has a single value. If the client wishes this to be a multivalue pair, then Successive calls to Add on the GMNVPair class will append values. These values can be enumerated using the standard collection semantics.
PropertiesCountReturns the number of values in this N/V Pair. NameThe Name of the N/V Pair _NewEnumAn enumerator to enumerate the Values. Invisible to VB clients. MethodsAddAppends a value to the end. ItemReturns the specified value. This takes a long as the index parameter. The index is 1 based. This is the default Method, and the default parameter is 1. The WorkArea Class This class encapsulates the Work Area functions in the Low Level API. Each method corresponds to an underlying function, and is simply a thin wrapper around the function. MethodsAppendAdds a new record, and returns the new record ID ReplaceReplaces a specific field at the current position DeleteDeletes the current record UnlockUnlocks after an update or an append has locked the work area ReadReads the contents of the specified field at the current position TopSets the current position to the top of the work area BottomSets the current position to the bottom of the work area SetOrderSets the current index tag on the table SeekPositions to the first record matching the seek value SkipSkips the specified number of records GotoMoves to the specified record MovePositions the record pointer to a particular record in a data file SearchPerforms a sequential search on a file FilterLimits access to data in a GoldMine database by creating a subset of records based on expression criteria. RangeActivates the index in a table, and set a range of values to limit the scope of data that GoldMine will search RecNoUsed to determine either current record number position (dBASE), or the record ID (SQL) IsSQLUsed to determine if the table is SQL (1) or dBASE (0). The LicenseInfo Class This class encapsulates the License Information of the current server. It is accessed from the Application object as a property.
Directory: downloads downloads -> Northern England’s set-jetting locations downloads -> Dynatest 3031 lwd light Weight Deflectometer downloads -> Forth coming competitive exams downloads -> Brush High School Morning Announcements Friday, September 05, 2014 all school downloads -> Year 9 The Arts — Music downloads -> Years 7 and 8 standard elaborations — Australian Curriculum: Music draft downloads -> Chris Young sets 2016 “I’m Comin’ Over” Tour headlining dates downloads -> Slavery and Abolition: the Plymouth Connection Introduction downloads -> Summer Assignment Download 465.93 Kb. Share with your friends:
|