In this topic: Hide
The only object that is created directly is the cm4dDoc object. Creating this object executes CM4D and provides an object for document manipulation. All of the other objects are created through the use of a parent object, starting with the cm4dDoc object at the root.
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetCM4DDatabaseSchema(); | float | |||
| UpdateDatabase(void); | LONG | This method updates changes to Site Configurations and Managed Documents to the Site Database. If a CM4D Document is open it is saved to update the Managed Document event choice, report choice, and managed routine information. |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CreateDataSet(BSTR label); | IQaDataSet* | |||
| GetDataSet(BSTR label); | IQaDataSet* | |||
| GetDataSetByPos(long pos); | IQaDataSet* | |||
| GetDataSetCount(); | long | |||
| UpdateDataSets() | Updates only the DataSets. | long |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetDataSourceByPos(long pos_); | IQaDbDataSource* | |||
| GetDataSourceCount(); | long | |||
| GetSchedulerDataSource(); | IQaSchedulerDataSource* | |||
| NewDataSource(); | IQaDbDataSource* |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CloseDocument(); | long | |||
| HideDocument(); | long | |||
| ManageCurrentDocument(BSTR name_, BSTR filename_, BSTR siteCode_, eManagedAsType type_); | Manage the current document. | LONG | This method will manage the current unmanaged document using the parameters passed and save the document using the provided filename. The Site Database is updated to reflect the change. A Universal Naming Convention (UNC) filename path maybe required by the system configuration. | |
| ManageCurrentDocumentAs(BSTR name_, BSTR filename_, BSTR siteCode_, eManagedAsType type_); | Manage the current document as a copy of the current document. The Site Database is updated to reflect the change. | LONG | This method will manage the current managed document using the parameters passed and save the document as a new document using the provided filename. The original managed document is unchanged and the current document becomes the newly saved document. The Site Database is updated to reflect the change. A UNC filename path maybe required by the system configuration. | |
| NewDocument(BSTR filename); | long | |||
| OpenDocument(BSTR documentName); | long | |||
| OpenOldDocument(BSTR documentName); | long | |||
| SaveAsDocument(BSTR documentName); | long | |||
| SaveDocument(); | long | |||
| ShowDocument(); | long | |||
| UnmanageCurrentDocument(void); | This method un-manages the current document. | LONG | The current document management settings are cleared and the document is saved as an unmanaged document. The Site Database is updated to reflect the change. |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetDocVersion(); | double | |||
| GetFilename(); | BSTR | |||
| IsDocManaged(); | Get Managed Document setting. | boolean | ||
| IsDocPathUNC(BSTR path_); | boolean | This method determines whether the passed path is a UNC Path. If an empty path is passed the path of the current opened document is used if any. |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetErrorString(long code); | BSTR | |||
| GetLastErrorCode(); | short |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetManagedDocumentByFilename(BSTR filename_); | Get a Managed Document from the loaded list by Filename (full path or filename) | IQaManagedDocument* | ||
| GetManagedDocumentByID(BSTR id_); | Get a Managed Document from the loaded list by Managed Document unique identifier. | IQaManagedDocument* | ||
| GetManagedDocumentByName(BSTR name_); | Get a Managed Document from the loaded list by Name. | IQaManagedDocument* | ||
| GetManagedDocumentByPos(LONG position_, BSTR siteCode_); | Get a Managed Document from the loaded list by list position within a specific Site Code. | IQaManagedDocument* | A passed Site Code value of “*” will be taken to mean within all loaded sites. An empty Site Code value “” will be taken to mean within the authenticated user’s default site. | |
| GetManagedDocumentCount(BSTR siteCode_); | Get Managed Document list count. | LONG | ||
| GetManagedDocumentsXML(void); | Get a list of all Managed Documents in XML format. | BSTR | Call to get Managed SheetSet information | |
| LoadManagedDocumentByFilename(BSTR filename_); | Load Managed Documents for the given filename. | IQaManagedDocument* | Event Choices, Report Choices, and Managed Routines are loaded for the selected document. | |
| LoadManagedDocumentByID(BSTR id_); | Load Managed Document by unique identifier. | IQaManagedDocument* | Event Choices, Report Choices, and Managed Routines are loaded for the selected document. | |
| LoadManagedDocuments(BSTR siteCode_, boolean loadSubordinates_); | LONG | Loading Managed Documents obtains a representation of the requested managed documents into the internal CM4D API memory list. This list will not allow any duplicates to be loaded and any attempt to do so will cause the older copy to be removed from the list and the new copy to be added. Keep this in mind for QaManagedDocument objects that were obtained prior to a call to this method (or other variations of this method) as they may no longer be valid. This method clears the CM4D API memory list and loads Managed Documents for the given site code. A passed Site Code value of “*” will be taken to mean all sites. An empty Site Code value “” will be taken to mean the authenticated user’s default site. Event Choices, Report Choices, and Managed Routines can be loaded by passing “True” for the loadSubordinates_ parameter. Loading a managed document does not open the represented CM4D Document nor does it affect any CM4D document that is open. A loaded Managed Document is available on the internal list for subsequent GetManagedDocument… calls. | ||
| UnloadManagedDocument(BSTR id_); | Unload Managed Document by unique identifier. | LONG | The identified Managed Document is removed from the CM4D API internal list. | |
| UnLoadManagedDocuments(BSTR siteCode_); | LONG | This method unloads (removes from the internal CM4D API list) Managed Documents for the given site code. A passed Site Code value of “*” will be taken to mean all sites. An empty Site Code value “” will be taken to mean the authenticated user’s default site. |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CreateManagedReport(void); | Create a new Managed Report | IQaManagedReport* | ||
| DeleteManagedReport(BSTR id_); | Delete an existing Managed Report | LONG | ||
| GetManagedReportByID(BSTR id_); | Get a Managed Report by unique identifier | IQaManagedReport* | ||
| GetManagedReportsXML(void); | Get a list of all Managed Reports in XML format | BSTR | Call to get Managed Report Label (string), Managed Report ID (GUID), Managed Report Properties (Report Name, Document Type, Tag Source, Depository and Managed SheetSets) |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| FrameMaximize(); | void | |||
| FrameMinimize(); | void | |||
| FrameRestore(); | void | |||
| GetCM4DVersion(); | double | |||
| GetImages(void); | Returns an object representing the QaImages list. | IQaImages* | ||
| MakeSnapShots(short res_); | long | |||
| ProcessEvents(); | long | |||
| ReloadEligibleAnnots(); | long | |||
| ShutDownCM4D(); | void | |||
| Update(); | long | |||
| UpdateAnnots(); | Updates annotation only. | long |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetPriviledgeByPos(long pos_, BSTR sitecode_); | BSTR | |||
| GetPriviledgeCount(BSTR sitecode_); | long |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CreateQuery(eQueryType type, BSTR label); | IQaQuery* | type = type of Query to create (see ENUM for eQueryType) label = label to assign to Query |
||
| CreateQueryDS(short type, BSTR queryLabel, BSTR dataSourceLabel); | IQaDbDataSource* | |||
| GetQuery(BSTR label); | IQaQuery* | |||
| GetQueryByPos(long pos); | IQaQuery* | |||
| GetQueryCount(); | long |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CreateSchedulerJobSetting(void); | Create a new Scheduler Job | IQaSchedulerJobSetting* | ||
| DeleteSchedulerJobSetting(BSTR id_); | Delete an existing Scheduler Job | LONG | ||
| GetSchedulerJobSettingByID(BSTR id_); | Get a Scheduler Job by unique identifier | IQaSchedulerJobSetting* | ||
| GetSchedulerJobSettingsXML(void); | Get a list of all Scheduler Jobs in XML format | BSTR |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CreateScore(BSTR label); | IQaScore* | |||
| GetScore(BSTR label); | IQaScore* | |||
| GetScoreByPos(long pos); | IQaScore* | |||
| GetScoreCount(); | long |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetSheet(BSTR label); | IQaSheet* | |||
| GetSheetByPos(long pos); | IQaSheet* | |||
| GetSheetCount(); | long |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CreateSheetSet(BSTR label); | IQaSheetSet* | |||
| GetSheetSet(BSTR sheetSetLabel); | IQaSheetSet* | |||
| GetSheetSetByPos(long pos); | IQaSheetSet* | |||
| GetSheetSetCount(); | long |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| GetSiteByCode(BSTR siteCode_); | Get Site Configuration by Site Code. | IQaSiteConfiguration* | ||
| GetSiteByLabel(BSTR siteLabel_); | Get Site Configuration by Site Label. | IQaSiteConfiguration* | ||
| GetSiteByPos(LONG position_); | Get Site Configuration by list position. | IQaSiteConfiguration* | ||
| GetSiteCodesByPos(long pos_); | BSTR | |||
| GetSiteCodesCount(); | long | |||
| GetSiteCount(void); | Get Site Configuration list count. | LONG | ||
| GetSiteDatabaseSchema(); | float | |||
| SiteDatabase(); | BSTR |
| Parameter | Description | Return Type | Input Parameters | Remarks |
| CreateStyle(BSTR label); | IQaStyle* | |||
| GetStyle(BSTR label); | IQaStyle* | |||
| GetStyleByPos(long pos); | IQaStyle* | |||
| GetStyleCount(); | long |
| Method | Description | Return Type | Input Parameters | Remarks |
| CreateWireframe(BSTR filename); | IQaWireframe* | |||
| GetWireframe(BSTR filename); | IQaWireframe* | |||
| GetWireframeByPos(long pos); | IQaWireframe* | |||
| GetWireframeCount(); | long |
| Property | Type | Description | Remarks |
| AllowAnnotOffSheet; | boolean | ||
| AllowAnnotSelectByTerminator; | boolean | ||
| AnnotErrorHandling; | eAnnotErrorHandling | ||
| AxisLabelX; | BSTR | ||
| AxisLabelY; | BSTR | ||
| AxisLabelZ; | BSTR | ||
| ChrNorLabel; | BSTR | ||
| ChrPosLabel; | BSTR | ||
| ComparePrecision; | long | ||
| DecimalPlaces; | long | ||
| DrawBlackAndWhite; | boolean | ||
| OpenWritable; | boolean | ||
| ScriptAnnot; | IQaAnnot* | ||
| ScriptSheet; | IQaSheet* | ||
| ShowAnnotGhostBorder; | boolean | ||
| SuspendQueryRefresh; | boolean | ||
| SuspendResolve; | boolean | ||
| Units; | eUnits | ||
| UseViewSnapshots; | boolean | ||
| ViewRotationAngle; | double |
Enum |
Help String | Description | Remarks |
| eUnitsInches | Inches | ||
| eUnitsMillimeters = 1, | Millimeters |
Enum |
Help String | Description | Remarks |
| eAnnotErrorHandlingAppendCode, | Append Code | ||
| eAnnotErrorHandlingAppendE, | Append 'E' | ||
| eAnnotErrorHandlingAppendMessage, | Append Message | ||
| eAnnotErrorHandlingLeaveEmpty | Leave Empty | ||
| eAnnotErrorHandlingNone = 0, | None |