Acquiredirect Api: User Guide
Acquiredirect Api: User Guide
User guide
Document information
Authorised use © acQuire Software Pty Ltd
Document name acQuireDirect API - User Guide
Date May 2017
Table of contents
1 Introduction 1
1.1 About acQuireDirect 1
1.1.1 Advantages of acQuireDirect 1
1.2 Obtaining acQuireDirect 1
1.3 Accessing modified data sets 1
1.4 Installation recommendations 2
1.4.1 acQuire Read API 2
1.4.2 acQuireDirect 64-bit 2
1.4.3 Conventions 2
1.5 Programming 2
1.6 Linking to acQuireDirect 3
1.7 Terms and abbreviations 3
2 Constructing a program 4
2.1 Overview 4
2.2 COM support interface 4
2.2.1 Loading a COM object 4
2.2.2 Registration of the COM object 4
3 API interface functions 5
3.1 AcqGetVersion 5
3.2 AcqHCreate 5
3.3 AcqHDestroy 5
3.4 AcqHResetSelection 5
3.5 AcqHSetInitialSettings3 5
3.6 AcqHSetParams 5
3.7 AcqHGetCurrentSettings3 6
3.8 AcqHGetCurrentParams 6
3.9 AcqHGetParamStruct 6
3.10 AcqHDeleteSettingStruct3 6
3.11 AcqHGetGeodeticOptions 6
3.12 AcqHDeleteGeodeticOptions 6
3.13 AcqHLoadParams 7
3.14 AcqHDeleteParams 7
3.15 AcqHStartSelection 7
The client software can access the date and time information implemented by object tracking in the database
via the API. This means that a refresh of the data set from within the client software is executed efficiently.
Utilising the client software local cache, data that has been modified will be replaced and data added since the
last refresh will be added to the current data set. Drillhole or point campaigns and associated data that has been
deleted from the acQuire 4 database will disappear from the client data set.
1.4.3 Conventions
To direct you to the particular option in acQuire 4, for example, the path will be written as follows:
Manage, SQL Server, Attach Database.
This means that you should open the Manage menu, then open SQL Server in the drop-down menu, then click
Attach Database.
1.5 Programming
This manual assumes prior experience of programming.
ODBC Object Data Base Connectivity. This controls the interactions between the database system and
an application program (such as the acQuire API).
DBMS Data Base Management System - for example MS SQL Server or Oracle.
Form A view of a table in the ADM. Forms are created and named in acQuire 4.
Compound form A view of a combination of tables in the ADM. The view appears similar to a form (a view of
one table), although some of the fields in the tables that constitute the compound form are
pivoted to appear as columns.
Compound forms are created in acQuire 4. A compound form is created or constructed from a
compound definition. The user can change the default name of the compound form.
Compound definition The query that defines the particular tables and the fields that are pivoted (virtual fields) in the
named form.
Object tracking Object tracking can be installed in the acQuire 4 database. It records when a change is made to
any part of a drillhole/point campaign combination. Each drillhole/point campaign combination
is known as an object. A record is kept of when and who made the change. The change to an
object could occur at any level in the database. For example, renaming or deleting a drillhole.
Description Get the acQuireDirect library version number. This is a long integer number representing the
acQuireDirect version ex. 4382 will represent the version 4.3.8.2.
3.2 AcqHCreate
Usage void *AcqHCreate(void);
Description Create an instance of the acQuireDirect object. The returned value should be passed to all subsequent
calls to the acQuireDirect library.
3.3 AcqHDestroy
Usage void AcqHDestroy(void *pAcqH);
Returns void
Description Destroy the acQuireDirect object. This function should be called to release the memory of the
acQuireDirect object. After this call the pAcqH handle will be invalid.
3.4 AcqHResetSelection
Usage void AcqHResetSelection(void *pAcqH);
Returns void
Description The selection settings will be reset to the default values. Any fields selected will be removed.
3.5 AcqHSetInitialSettings3
Usage void AcqHSetInitialSettings3(void *pAcqH, const AcqParamStruct3
*pParam);
Returns void
Description Set the initial state of the user selection. The selection is passed as the AcqParamStruct3 structure.
3.6 AcqHSetParams
Usage void AcqHSetParams(void *pAcqH, const AcqDirectParam *pParam);
Returns void
Description Set the settings for acQuireDirect. AcqDirectParam contains a full set of parameters therefore this
function should be used. The function above can be used to set parameters modified by the client
program.
Description Create and allocate the settings structure with the currently selected options.
3.8 AcqHGetCurrentParams
Usage AcqDirectParam *AcqHGetCurrentParams(void *pAcqH);
Description Create and allocate the settings structure with the currently selected options. Use this function to
keep the settings for later use. The AcqDirectParam structure contains the full selection information.
3.9 AcqHGetParamStruct
Usage AcqParamStruct3 *AcqHGetParamStruct(void *pAcqH, const AcqDirectParam
*pParam);
Description Create and allocate the settings structure with the currently selected options. AcqDirectParam
structure contains the full selection set but it is in the form that can’t be interpreted by the client
program. Use this function to convert the AcqDirectParam to AcqParamStruct3.
3.10 AcqHDeleteSettingStruct3
Usage void AcqHDeleteSettingStruct3(AcqParamStruct3 *Setting);
Returns void
Description Delete the allocated structure. It is recommended to use this function to delete the structure created
via AcqHGetCurrentSettings3 or AcqHGetParamStruct.
3.11 AcqHGetGeodeticOptions
Usage AcqGeodTransformOptions *AcqHGetGeodeticOptions(void *pAcqH);
Description Get the geodetic options selected. AcqGeodTransformOptions defines the destination grid and all the
grids required to transform it to a geographic grid. It is an array of grid definitions where the
destination grid is at index NumGrid-1 and the top grid is at index 0.
3.12 AcqHDeleteGeodeticOptions
Usage void AcqHDeleteGeodeticOptions(void *pAcqH, AcqGeodTransformOptions
*pOptions);
Returns void
3.14 AcqHDeleteParams
Usage void AcqHDeleteParams(void *pAcqH, AcqDirectParam *Param);
Description Delete the allocated structure. You must call this function to delete the structure created via
AcqHGetCurrentParams or AcqHLoadParams.
3.15 AcqHStartSelection
Usage int AcqHStartSelection(void *pAcqH);
3.16 AcqHSelectItemsOnly
Usage int AcqHSelectItemsOnly(void *pAcqH);
Description Show the selection dialog with items selections only (it will not be possible to change the connection
or any Collar settings).
3.17 AcqHGetDataFromAcquire
Usage int AcqHGetDataFromAcquire(void *pAcqH);
Returns 1 if successful.
0 if failed.
Description acQuireDirect will open the select queries and prepare for the execution. The data is not fetched at
this stage.
3.18 AcqHGetModifiedDataFromAcquire
Usage int AcqHGetModifiedDataFromAcquire(void *pAcqH, long SinceTime);
Returns Integer
Description Retrieve the data changed since the given date from acQuire 4. SinceTime is of time_t type.
Returns Integer
Description Get the number of drillholes /surveys available based on the selection criteria. This function can be
called after AcqHGetDataFromAcquire or AcqHGetModifiedDataFromAcquire.
3.20 AcqHGetDeletedHoles
Usage void AcqHGetDeletedHoles(void *pAcqH, AcqHStringArray *pHoles,
AcqHStringArray *pProjects);
Returns void
Description Get the holes that were deleted since the time required. This function can be called after
AcqHGetModifiedDataFromAcquire.
3.21 AcqHGetHoleData4
Usage AcqDrillhole4 *AcqHGetHoleData4(void *pAcqH, unsigned int Index);
Description After the call to AcqHGetDataFromAcquire or AcqHGetModifiedDataFromAcquire, the data for the
selected holes or surveys can be fetched in the sequential order. Call this function in the loop to
access the data for the given Hole or Survey.
3.22 AcqHDeleteHoleData4
Usage void AcqHDeleteHoleData4(void *pAcqH, AcqDrillhole4 *pHole);
Returns void
Description Delete the memory allocated for the Hole or Survey data.
3.23 AcqHGetCollarFunctionFields
Usage void AcqHGetCollarFunctionFields(void *pAcqH, AcqHStringArray
*pFields);
Returns An array of field names in the order HoleID, ProjectCode, East, North, RL Depth.
Description Get the database field names of the HoleID, ProjectCode, East,North, RL and Depth.
3.24 AcqHGetExtendedCollarFunctionFields
Usage void AcqHGetExtendedCollarFunctionFields(void *pAcqH, AcqHStringArray
*pFields);
Returns An array of field names in the order HoleID, ProjectCode, East, North, RL, Depth, GridName,
TenementID.
Description Get the database Collar field names of HoleID, ProjectCode, East, North, RL, Depth, GridName and
TenementID.
Returns The Types, Lengths and Precisions of the fields requested in Field array.
Input pFields
3.26 AcqHAddSelectedCollarField
Usage void AcqHAddSelectedCollarField(void *pAcqH, LPCTSTR Field);
Returns void
3.27 AcqHAddSelectedAssay
Usage void AcqHAddSelectedAssay(void *pAcqH, LPCTSTR Assay);
Returns void
3.28 AcqHAddSelectedGeology
Usage void AcqHAddSelectedGeology(void *pAcqH, LPCTSTR Code);
Returns void
3.29 AcqHClearSelectedItems
Usage void AcqHClearSelectedItems(void *pAcqH);
Returns void
Description Delete all selected Items from Assay and Geology pages.
Returns void
Description Add the Assay or Geology item to the selected list. Use this function if it is unknown if the Item is
Geology or Assay.
3.31 AcqHSetUseIncludeCoordinates
Usage void AcqHSetUseIncludeCoordinates(void *pAcqH, BOOL Use);
Returns void
3.32 AcqHSetIncludeCoordinates
Usage void AcqHSetIncludeCoordinates(void *pAcqH, double MinEast, double
MaxEast, double MinNorth, double MaxNorth, double MinRL, double MaxRL);
Returns void
3.33 AcqHSetUseExcludeCoordinates
Usage void AcqHSetUseExcludeCoordinates(void *pAcqH, BOOL Use);
Returns void
3.34 AcqHSetExcludeCoordinates
Usage void AcqHSetExcludeCoordinates(void *pAcqH, double MinEast, double
MaxEast, double MinNorth, double MaxNorth, double MinRL, double MaxRL);
Returns void
3.35 AcqHGetAssayFunctionFields
Usage void AcqHGetAssayFunctionFields(void *pAcqH, AcqHStringArray *pFields);
3.37 AcqHDestroyAcqAssays
Usage void AcqHDestroyAcqAssays(AcqAssays *pAssayCodes);
Returns void
3.38 AcqHIsAssayTypeNumeric
Usage BOOL AcqHIsAssayTypeNumeric(void *pAcqH, LPCTSTR Assay);
Returns boolean
3.39 AcqHGetGeologyFunctionFields
Usage void AcqHGetGeologyFunctionFields(void *pAcqH, int Page,
AcqHStringArray *pFields);
Description Get the database field names from the given Geology page.
Input pFields
Output pAssayCodes
3.41 AcqHGetPageGeologyFieldDefinitions
Usage void AcqHGetPageGeologyFieldDefinitions(void *pAcqH, int Page, const
AcqHStringArray *pFields, AcqHWordArray *pTypes, AcqHWordArray
*pLengths, AcqHWordArray *pPrecs);
Returns An array of field names initialised to HoleID, ProjectCode, Depth, Azimuth, Dip, Priority, SurveyType.
3.43 AcqHGetSurveyFieldDefinitions
Usage void AcqHGetSurveyFieldDefinitions(void *pAcqH, const AcqHStringArray
*pFields, AcqHWordArray *pTypes, AcqHWordArray *pLengths, AcqHWordArray
*pPrecs);
3.44 AcqHGetAliases
Usage void AcqHGetAliases(void *pAcqH, LPCTSTR Client, LPCTSTR CD,
AcqHStringArray *pFields, AcqHStringArray *pAliases);
Input Client, CD
Description Get the field aliases for the given client and compound definition. The alias table contains the field
names to be substituted during drillhole or point sample export.
3.45 AcqHUpdateAliases
Usage BOOL AcqHUpdateAliases(void *pAcqH, LPCTSTR Client, LPCTSTR CD, const
AcqHStringArray *pAcqFields, const AcqHStringArray *pAliases);
Description Update the database with the given aliases for the given client and compound definition.
3.46 AcqHGetOperationMode
Usage ACQXOPERATIONMODES AcqHGetOperationMode(void *pAcqH);
Returns ACQXOPERATIONMODES
Description Get the current operating mode selecting either DRILLHOLES or POINTSAMPLES.
3.47 AcqHSetOperationMode
Usage void AcqHSetOperationMode(void *pAcqH, ACQXOPERATIONMODES nNewMode);
Returns void
3.48 AcqHSetConnectionString
Usage void AcqHSetConnectionString(void *pAcqH, LPCTSTR ConnString);
Returns void
3.49 AcqHSetConnection
Usage void AcqHSetConnection(void *pAcqH, LPCTSTR ODBC, LPCTSTR User, LPCTSTR
Password);
Returns void
Description Set the new connection details and reconnect with new user/password/ODBC.
3.50 AcqHHideConnectionPage
Usage void AcqHHideConnectionPage(void *pAcqH, int Hide);
Returns void
3.51 AcqHConnect
Usage short AcqHConnect(void *pAcqH);
Returns 0 if successful.
-1 if failed.
Returns 0 if successful.
-1 if failed.
3.53 AcqHEnableMultiGeology
Usage void AcqHEnableMultiGeology(void *pAcqH, int Enable);
Returns void
3.54 AcqHGetValidationLookups
Usage int AcqHGetValidationLookups(void *pAcqH, LPCTSTR CDName, LPCTSTR
Field, AcqHStringArray *pValues, LPCTSTR ExtraField, AcqHStringArray
*pExtraValues);
Returns Validation lookup values. If ExtraField is defined the values for this field is returned as well.
Description Get the validation lookup for the given compound definition and field.
Output pLookups
Description Get the values for the given field from the given ‘function’. The ‘function’ can be one of following:
Assay, Geology, Survey, Collar. This allows accessing the data from the table or compound definition
without knowing its origin.
3.56 AcqHGetCDFields
Usage void AcqHGetCDFields(void *pAcqH, LPCTSTR CDName, AcqHStringArray
*pFields);
Input CDName
Output pFields
3.57 AcqHGetFormDefFields
Usage void AcqHGetCDFields(void *pAcqH, LPCTSTR CDName, AcqHStringArray
*pFields);
Output pFields
Description Get fields from the given form definition identified by Category and FormDef.
3.58 AcqHGetGeolPrimaryCode
Usage LPCTSTR AcqHGetGeolPrimaryCode(void *pAcqH, LPCTSTR Code);
Description Get the primary code for the given secondary code or NULL if not defined.
3.59 AcqHSetCollarBasedOn
Usage void AcqHSetCollarBasedOn(void *pAcqH, LPCTSTR CD);
Returns void
Description Set the compound definition that the Collar data is based on.
This may be required if the form definition is not defined.
Returns void
Description Set the compound definition that the Assay data is based on.
This may be required if the form definition is not defined.
3.61 AcqHSetGeologyBasedOn
Usage void AcqHSetGeologyBasedOn(void *pAcqH, LPCTSTR CD);
Returns void
Description Set the compound definition that the Geology data is based on.
This may be required if the form definition is not defined.
3.62 AcqHSetSurveyBasedOn
Usage void AcqHSetSurveyBasedOn(void *pAcqH, LPCTSTR CD);
Returns void
Description Set the compound definition that the Survey data is based on.
This may be required if the form definition is not defined.
3.63 AcqHDeleteHoleFromDatabase
Usage int AcqHDeleteHoleFromDatabase(void *pAcqH, LPCTSTR HoleID, LPCTSTR
ProjectCode);
Returns void
3.64 AcqHRenameHole
Usage int AcqHRenameHole(void *pAcqH, LPCTSTR OldHoleID, LPCTSTR
OldProjectCode, LPCTSTR NewHoleID, LPCTSTR NewProjectCode);
Returns 1 if successful.
0 if failed.
3.65 AcqHAddSelectedHoles
Usage void AcqHAddSelectedHoles(void *pAcqH, const AcqHStringArray *pHoleIDs,
const AcqHStringArray *pProjects);
Returns void
3.67 AcqHEndTransaction
Usage BOOL AcqHEndTransaction(void *pAcqH, BOOL Commit);
3.68 AcqHGetLastError
Usage void AcqHGetLastError(void *pAcqH, char *pcError, long lLength);
3.69 AcqHUpdateGeology
Usage BOOL AcqHUpdateGeology(void *pAcqH, LPCTSTR HoleID, LPCTSTR
ProjectCode, LPCTSTR SecondaryCode, double Priority, BOOL
DeletePrevious, int NumberOfIntervals, const AcqXGeologyIntervalType
*pIntervals);
Description Update the Geology intervals for the given SecondaryCode and Priority. DeletePrevious
will delete existing codes first.
Only Codes with primary code prefix defined by FUNCTION GEOUPDATABLE can be updated.
FUNCTION is set in METAFUNCTION table.
3.70 AcqHGetServerTime
Usage long AcqHGetServerTime(void *pAcqH);
3.72 AcqHSaveSettingsAsDefaults
Usage void AcqHSaveSettingsAsDefaults(void *pAcqH, LPCTSTR Profile, const
AcqDirectParam *pParams);
Returns void
Description Save the given settings as the default parameters under the given profile.
3.73 AcqHSaveCurrentSettingsAsDefaults
Usage void AcqHSaveCurrentSettingsAsDefaults(void *pAcqH, LPCTSTR Profile);
Returns void
Description Save the current settings as the default parameters under the given profile.
3.74 AcqHLoadSettingsFromDefaults
Usage void AcqHLoadSettingsFromDefaults(void *pAcqH, LPCTSTR Profile);
Returns void
Description Load the settings from the default table and sets them as the current selection.
3.75 AcqHGetObjectLoggingStatus
Usage int AcqHGetObjectLoggingStatus(void *pAcqH);
Returns ON or OFF
Description Return the status of the object logging system. It will be required for the loading data that has been
modified since a given time.
3.76 AcqHSetSurveyMethod
Usage void AcqHSetSurveyMethod(void *pAcqH, short nNewValue);
Returns void
Description Set the desurvey method that will be used. The desurvey method available are
DESURVFITSPLINE = 0
DESURVBACKCALC = 1
DESURVSEMITANGENT = 2
DESURVSPLITSEG = 3
NODESURVEYING = 4
3.78 AcqHCreateStringArray
Usage int AcqHCreateStringArray(AcqHStringArray *pStr, int Count);
Description Create the array of Count strings. This array is used in number of functions to pass the array of data,
ex. Field names or lookup values.
3.79 AcqHSetStringAt
Usage void AcqHSetStringAt(const AcqHStringArray *pStr, int Index, LPCTSTR
Str);
Description Set the given string at the given index in the pStr array.
3.80 AcqHAddString
Usage void AcqHAddString(AcqHStringArray *pStr, LPCTSTR Str);
Description Add the given string to the array. The size of the array will be automatically increased.
3.81 AcqClose
Usage void AcqClose(void)
3.82 AcqHSetErrorFileName
Usage void AcqHSetErrorfileName(LPCTSTR sFileName)
Description Set the folder where the log files will be created.
3.84 AcqHSetConnectionTrusted
Usage void AcqHSetConnectionTrusted(void *pAcqH, int On)
3.85 AcqHGetCompoundAliases
Usage void AcqHGetCompoundAliases(void *pAcqH, LPCTSTR Client, LPCTSTR CD,
LPCTSTR Category, LPCTSTR FormName, AcqHStringArray *pFields,
AcqHStringArray *pAliases)
Description Get aliases for the fields defined by the form definition.
If Category and FormName are defined and the form definition is valid, returns fields and aliases
for this form definition.
If the compound definition is defined, returns all fields and aliases for this compound definition.
3.86 AcqHForceShowConnectionPage
Usage void AcqHForceShowConnectionPage(void *pAcqH, int Set)
Description If the client passes the connection string the connection page will not be displayed. To force the
connection page anyway call this function.
3.87 AcqHSetCollarItemsDefaultOptions
Usage void AcqHSetCollarItemsDefaultOptions(void *pAcqH, int MaxLength, int
Increment, int NoOfDecimals)
3.88 AcqHSetAssayItemsDefaultOptions
Usage void AcqHSetAssayItemsDefaultOptions(void *pAcqH, int MaxLength, int
Increment, int NoOfDecimals)
3.89 AcqHSetGeologyItemsDefaultOptions
Usage void AcqHSetGeologyItemsDefaultOptions(void *pAcqH, int MaxLength, int
Increment, int NoOfDecimals)
3.91 AcqHSetBoundingBox
Usage void AcqHSetBoundingBox(void *pAcqH, const AcqCoord *pMin, const
AcqCoord *pMax, const AcqGeodGridDef *pGridDef)
Description Set the bounding box defined in the grid defined by pGridDef.
pGridDef can be NULL, in which case it is assumed that the box coordinates are in the same grid as
the destination grid.
3.92 AcqHForceDestinationGridSelection
Usage void AcqHForceDestinationGridSelection(void *pAcqH, BOOL bForce)
Description Force the user to select the destination grid and apply transformation.
3.93 AcqHUpdateSettings
Usage void AcqHUpdateSettings(void *pAcqH, const AcqParamStruct3 *pParam)
Description Update the settings defined in pParam structure only. It will not affect the settings outside of this
structure.
3.97 AcqHDeleteSpatialSelectionOptions
Usage void AcqHDeleteSpatialSelectionOptions(void *pAcqH,
AcqSpatialSelectionSettings *pOptions);
3.98 AcqHSetCombineParams
Usage void AcqHSetCombineParams(void *pAcqH, BOOL on, LPCTSTR
controlPageName, BOOL commonIntervals, BOOL fillGaps, BOOL
combineAllCodesToAssayIntervals);
Description Set the options for splitting and combining intervals. The parameters are:
controlPageName: To use the controlling interval option for combining pages, set this
parameter to the name of the page containing the controlling intervals.
commonIntervals: To use the smallest common interval option for combining pages, set this
parameter to 1.
fillGaps: This option can be used to fill missing intervals, if needed.
combineAllCodesToAssayIntervals: If this option is set to 1, all geology codes from the
list of pages to be combined will be displayed against the assay intervals.
Note: Use AcqHAddPageToCombine to add the pages to be combined.
3.99 AcqHAddPageToCombine
Usage void AcqHAddPageToCombine(void *pAcqH, LPCTSTR PageName);
Description Add pages to be combined when using the split/combine intervals functionality.
3.100 AcqHCombineSurveyCodesToAssayIntervals
Usage void AcqHCombineSurveyCodesToAssayIntervals(void *pAcqH, BOOL on);
Returns void
Description Assigns the survey intervals data to assay intervals. All the data will be returned in the Assay part of
the drillhole data structure.
3.101 AcqHEnableMultiAssay
Usage void AcqHEnableMultiAssay(void *pAcqH, int Enable);
Returns void
Description Enable or disable selection of more than one assay page. Default is disabled.
Description Create and allocate the settings structure with the currently selected options, where AcqParamStrct4
is:
typedef struct AcqParamStruct4
{
AcqParamStruct3 *Params;
int NumAssaySelections;
AcqAssaySelection **Assays;
} AcqParamStruct4;
3.103 AcqHUpdateSettings4
Usage void AcqHUpdateSettings4(void *pAcqH, const AcqParamStruct4 *pParam);
Returns void
Description Update the settings defined in pParam structure only. It will not affect the settings outside this
structure.
3.104 AcqHDeleteSettingStruct4
Usage void AcqHDeleteSettingStruct4(AcqParamStruct4 *pSetting);
Returns void
Description Delete the allocated structure. It is recommended to use this function to delete the structure created
using AcqHGetCurrentSettings4.
3.106 AcqHDeleteAcquireData
Usage void AcqHDeleteAcquireData(void *pAcqH, AcquireObject *pData);
Returns void
Description Delete the allocated structure. It is recommended to use this function to delete the structure created
using AcqHGetAcquireData.
3.107 AcqHCacheData
Usage void AcqHCacheData(void *pAcqH)
Returns void
Description Set this option to cache the data in the tables. The user can then get the data directly from the tables.
3.108 AcqHGetCacheTablesNames
Usage AcqCacheTables AcqHGetCacheTablesNames(void *pAcqH)
Returns AcqCacheTables
Returns void
3.110 AcqHDeleteCacheTablesNames
Usage void AcqHDeleteCacheTablesNames(void *pAcqH, AcqCacheTables *ct)
Returns void
3.111 AcqHCacheProfile
Usage void AcqHCacheProfile(void *pAcqH, const char *profileName)
Returns void
Description Creates and populates the tables related to the saved profile.
4.1 AcqHGetCollarAggregateData
Usage AcqAggregateCatalog *AcqHGetCollarAggregateData(void *pAcqH);
4.2 AcqHGetPointAggregateData
Usage AcqAggregateCatalog *AcqHGetPointAggregateData(void *pAcqH);
4.3 AcqHDeleteAggregateData
Usage void AcqHDeleteAggregateData(void *pAcqH AcqAggregateCatalog *pData);
Returns void
5.2 AcqHDestroyFilter
Usage void AcqHDestroyFilter(void *pAcqH, char *pFilter)
5.3 AcqHAddGroupToFilter
Usage int AcqHAddGroupToFilter(void *pAcqH, char **Filter, unsigned int
*Size,const char *LinkToPrevious)
5.4 AcqHAddFieldToFilter
Usage int AcqHAddFieldToFilter(void *pAcqH, char **Filter, unsigned int
*Size, const char *CompoundDef, const char *Table, int Group, const
char *Field, const char *Operator,const char *Val1, const char *Val2,
const char *LinkToPrevious)
Returns If successful: 1.
If unsuccessful: 0 or -1: 0 if passed filter is valid; or-1 if passed filter is invalid.
5.5 AcqHSetFilterCustomSQL
Usage int AcqHSetFilterCustomSQL(void *pAcqH, char **pFilter, unsigned int
*Size, LPCTSTR SQL)
5.7 AcqHSetCollarFilter
Usage void AcqHSetCollarFilter(void *pAcqH, const char *Filter, unsigned int
Size)
5.8 AcqHSetAssayFilter
Usage void AcqHSetAssayFilter(void *pAcqH, const char *Filter, unsigned int
Size)
5.9 AcqHSetGeologyFilter
Usage void AcqHSetGeologyFilter(void *pAcqH, int Page,const char *Filter,
unsigned int Size)
6.1 AcqConnectToDatabase
Usage int STDAPICALLTYPE AcqConnectToDatabase(void);
Returns 0 if successful.
-1 if failed.
6.2 AcqSetMaxNumOfSurveyIntervals
Usage int STDAPICALLTYPE AcqSetMaxNumOfSurveyIntervals(int Max);
Returns 0 if successful.
-1 if failed.
6.3 AcqAddSelectedCollarField
Usage void STDAPICALLTYPE AcqAddSelectedCollarField(LPCTSTR Field);
Returns void
6.4 AcqAddSelectedAssay
Usage void STDAPICALLTYPE AcqAddSelectedAssay(LPCTSTR Assay);
Returns void
6.5 AcqAddSelectedGeology
Usage void STDAPICALLTYPE AcqAddSelectedGeology(LPCTSTR Code);
Returns void
Returns void
6.7 AcqClearSelectedItems
Usage void STDAPICALLTYPE AcqClearSelectedItems(void);
Returns void
Description Delete all selected Items from Assay and Geology pages.
6.8 AcqSetCombineControlPage
Usage void STDAPICALLTYPE AcqSetCombineControlPage(LPCTSTR PageName);
Returns void
Description Set which page should be used as the control page for combining intervals.
6.9 AcqSetCombineOption
Usage void STDAPICALLTYPE AcqSetCombineOption(short Option);
Returns void
Description Set the combine intervals option to Common intervals (1) or controlled by item intervals (0).
6.10 AcqAddPageToCombine
Usage void STDAPICALLTYPE AcqAddPageToCombine(LPCTSTR PageName);
Returns void
6.11 AcqSetCombineOn
Usage void STDAPICALLTYPE AcqSetCombineOn(short On);
Returns void
Returns void
Description Set the desurvey method that will be used. The desurvey methods available are:
DESURVFITSPLINE = 0
DESURVBACKCALC = 1
DESURVSEMITANGENT = 2
DESURVSPLITSEG = 3
NODESURVEYING = 4
6.13 AcqSetSurveyInterval
Usage void STDAPICALLTYPE AcqSetSurveyInterval(short nNewValue);
Returns void
6.14 AcqSetIncludeCoordinates
Usage void STDAPICALLTYPE AcqSetIncludeCoordinates(double MinEast, double
MaxEast, double MinNorth, double MaxNorth, double MinRL, double MaxRL);
Returns void
6.15 AcqSetUseIncludeCoordinates
Usage void STDAPICALLTYPE AcqSetUseIncludeCoordinates(BOOL Use);
Returns void
6.16 AcqSetExcludeCoordinates
Usage void STDAPICALLTYPE AcqSetExcludeCoordinates(double MinEast, double
MaxEast, double MinNorth, double MaxNorth, double MinRL, double MaxRL);
Returns void
6.17 AcqGetServerTime
Usage long int STDAPICALLTYPE AcqGetServerTime();
Returns ON or OFF
6.19 AcqSetMode
Usage int STDAPICALLTYPE AcqSetMode(ACQXOPERATIONMODES nNewMode);
6.20 AcqEnableFullSelection
Usage int STDAPICALLTYPE AcqEnableFullSelection(int Enable);
6.21 AcqEnableMultiGeologySelection
Usage int STDAPICALLTYPE AcqEnableMultiGeologySelection(int Enable);
6.22 AcqSetConnectionString
Usage int STDAPICALLTYPE AcqSetConnectionString(LPCTSTR ConnString);
6.23 AcqObjectOpenForSaving
Usage int STDAPICALLTYPE AcqObjectOpenForSaving(LPCTSTR FileName);
Description Open the file for saving. This is the compound file into which any data can be saved.
Description Write the selection criteria to the file identified by the ObjectHandler.
6.25 AcqObjectOpenFolder
Usage int STDAPICALLTYPE AcqObjectOpenFolder(int ObjectHandler, int
DirHandler, const char *Name);
6.26 AcqObjectOpenFile
Usage int STDAPICALLTYPE AcqObjectOpenFile(int ObjectHandler, const char
*Name);
Description Open the file in the directory identified by the ObjectHandler and DirHandler inside the
compound file.
6.27 AcqObjectWriteCurrentSelection
Usage int STDAPICALLTYPE AcqObjectWriteCurrentSelection(int ObjectHandler);
6.28 AcqObjectStartClientSection
Usage int STDAPICALLTYPE AcqObjectStartClientSection(int ObjectHandler, int
Version const char *ClientName);
Description Start the new client selection (defined by version) inside the compound file.
6.29 AcqObjectCloseSection
Usage int STDAPICALLTYPE AcqObjectCloseSection(int ObjectHandler, int
Storage);
Description Write the double value to the file in the compound file.
6.31 AcqObjectWriteSingle
Usage int STDAPICALLTYPE AcqObjectWriteSingle(int StreamHandler, float
fValue);
Description Write the single value to the file in the compound file.
6.32 AcqObjectWriteString
Usage int STDAPICALLTYPE AcqObjectWriteString(int StreamHandler, const char
*Str);
6.33 AcqObjectWriteVariant
Usage int STDAPICALLTYPE AcqObjectWriteVariant(int StreamHandler, VARIANT
*Var);
Description Write the variant value to the file in the compound file.
6.34 AcqObjectOpenForReading
Usage int STDAPICALLTYPE AcqObjectOpenForReading(LPCTSTR FileName);
6.35 AcqObjectReadSelection
Usage int STDAPICALLTYPE AcqObjectReadSelection(int ObjectHandler, VARIANT
*pParm);
Description Set the selection settings for acQuireDirect from the VARIANT read from the compound file.
6.37 AcqObjectReadInt
Usage int STDAPICALLTYPE AcqObjectReadInt(int StreamHandler, int *iValue);
6.38 AcqObjectReadDouble
Usage int STDAPICALLTYPE AcqObjectReadDouble(int StreamHandler, double
*dValue);
6.39 AcqObjectReadSingle
Usage int STDAPICALLTYPE AcqObjectReadSingle(int StreamHandler, float
*fValue);
6.40 AcqObjectReadVariant
Usage int STDAPICALLTYPE AcqObjectReadVariant(int StreamHandler, VARIANT
*Var);
6.41 AcqObjectClose
Usage int STDAPICALLTYPE AcqObjectClose(int ObjectHandler);
Description Hole data functions, returning the data associated with the hole from the given Index.
The data should be fetched in sequential order.
6.44 AcqGetItemDescription
Usage int STDAPICALLTYPE AcqGetItemDescription(LPCTSTR Category, LPCTSTR
Form, AcqXItemInfo *pItem);
6.45 AcqGetItemLookups
Usage int STDAPICALLTYPE AcqGetItemLookups(LPCTSTR Category, LPCTSTR Form,
AcqXLookups*pLookups);
6.46 AcqGetGeologyTypes
Usage int STDAPICALLTYPE AcqGetGeologyTypes(int Page, VARIANT *pFields,
VARIANT *pTypes, VARIANT *plsCode);
Description Get the Assay item types. pFields should have the item names that are required. pTypes and plsCode
should be initialised as an array and be of the correct size.
6.48 AcqGetSurveyTypes
Usage int STDAPICALLTYPE AcqGetSurveyTypes(VARIANT *pFields, VARIANT *pTypes,
VARIANT *pLength);
Description Get the Survey item types. pFields should have the item names that are required. pTypes and pLength
should be of the correct size.
6.49 AcqStartUpdate
Usage BOOL STDAPICALLTYPE AcqStartUpdate(BOOL NoCommit);
Description Start updating the database. If NoCommit is True, it will not commit the changes until
AcqEndTransaction is called. Otherwise all the changes will be committed automatically.
6.50 AcqEndTransaction
Usage BOOL STDAPICALLTYPE AcqEndTransaction(BOOL Commit);
6.51 AcqAddHoleIN
Usage BOOL STDAPICALLTYPE AcqAddHoleIN(LPCTSTR HoleID, LPCTSTR ProjectCode);
6.52 AcqSelectItemsOnly
Usage int STDAPICALLTYPE AcqSelectItemsOnly();
Description Show the selection dialog with items selections only (no connection change or Collar selection).
Description Insert the new hole to the database. Only Collar data and Survey intervals are supported at this stage.
6.54 AcqSaveSettingsAsDefaults
Usage void STDAPICALLTYPE AcqSaveSettingsAsDefaults(LPCTSTR Profile,
AcqDirectParam *pParams);
Returns void
Description Save the given settings as the default parameters under the given profile.
6.55 AcqSaveCurrentSettingsAsDefaults
Usage void STDAPICALLTYPE AcqSaveCurrentSettingsAsDefaults(LPCTSTR Profile);
Returns void
Description Save the current settings as the default parameters under the given profile.
6.56 AcqLoadSettingsFromDefaults
Usage void STDAPICALLTYPE AcqLoadSettingsFromDefaults(LPCTSTR Profile);
Returns void
Description Load the settings from the default table and sets them as the current selection.
6.57 AcqResetSelection
Usage void STDAPICALLTYPE AcqResetSelection();
Returns void
6.58 AcqCloseLibrary
Usage void STDAPICALLTYPE AcqCloseLibrary();
Returns void
Geographic
Two different operations are available on this dialog:
Dynamic grid transformation, with the results included in the client data set.
Define a client data subset by drillholes/points that occur within or outside defined coordinate limits, or
relative to 2D or 3D shapes imported from other applications.
This selection method is applicable for both Operation Mode = DRILLHOLE and POINTSAMPLE.
The Redefine coordinate fields button provides the opportunity to select fields for simple local coordinate
transformations.
Geology
Select the Geology form definition that best defines the data that is to be included in the client data set.
A filter, similar to that for Assay, can be applied to further define the subset. The Field list for this dialog
represents those of the selected Geology form definition.
The fields that will be included in the client data set are defined by selecting fields in the Use column.
Further sets of Geology data can be presented to the client by selecting the buttons highlighted in the graphic
below. These sets each have their own form definition and fields. All Geology sets are available in the client data
set.
The Geology dialog presents options to:
Combine overlapping intervals. If this is selected, intervals are combined in such a way as to eliminate
overlaps.
Preserve 0 length intervals. This is applicable when combining intervals. If this is selected, zero length
intervals will be treated as valid and included in the output.
Official information
acQuire Software Pty Ltd is the owner of the software and all icons and logos within the software, together with
all soft and hardcopy documentation.
This document is copyright. No part of this document may be reproduced by any process, or in any form,
without prior written consent from acQuire Technology Solutions Pty Ltd.
Disclaimer
acQuire Software Pty Ltd will not accept any liability arising from the use of the software or any other software
product mentioned in this document; nor for any technical or editorial errors or omissions made in this
document. The mention of any other computer software product in this document does not imply the
endorsement of such product by acQuire Software Pty Ltd.