PC-DMIS 2021.2 Object Library
Application Object Members
See Also  Overview  Send Topic Feedback | See Object Hierarchy Chart
PCDLRN ActiveX DLL : Application Object

Glossary Item Box

Public Methods

Public Method _AddRegistrySetting 
Public Method ChangeLanguageSet the new langugage
Public Method DeleteRegistryKeyDeletes a key and all its subkeys from the registry
Public Method DeleteRegistryValueDeletes a value from the registry
Public Method ExportRegistrySettings 
Public Method GetAvailableLanguagesReturns the list of available PCDMIS languages IDs or descriptions.
Public Method GetHelpMapReturns help map for menu id, used by online help
Public Method GetLanguageDescriptionReturns the descriptions of supplied language. The description is in the current PCDMIS language
Public Method GetRegistryBoolGets a boolean from the registry
Public Method GetRegistryDoubleGets a double from the registry
Public Method GetRegistryDWORDGets a DWORD from the registry
Public Method GetRegistryIntGets an integer from the registry
Public Method GetRegistryPointGets an XYZ triple from the registry
Public Method GetRegistryRootGets the registry root for current PCDMIS version
Public Method GetRegistrySettingsGets the settings object for the application
Public Method GetRegistryStringGets a string from the registry
Public Method GetSystemDocumentsGets the Document Folder. The Generic or Version Specific folder is returned according the bVersionSpecific parameter
Public Method GetSystemHiddenFolderGets the System Hidden Folder. The Generic or Version Specific folder is returned according the bVersionSpecific parameter
Public Method GetSystemReportingFolderGets the Sustem Reporting Folder. The Generic or Version Specific folder is returned according the bVersionSpecific parameter
Public Method GetUserHiddenFolderGets the User Hidden Folder. The Generic or Version Specific folder is returned according the bVersionSpecific parameter
Public Method GetUserVisibleFolderGets the User Visible Folder. The Generic or Version Specific folder is returned according the bVersionSpecific parameter
Public Method HelpCalls and opens a help file and topic.
Public Method ImportRegistrySettings 
Public Method MaximizeThe Maximize Subroutine expands the PC-DMIS window to full-screen size.
Public Method MinimizeThe Minimize subroutine reduces the PC-DMIS window to the taskbar.
Public Method PartProgramMirrorThis allows you to create a mirror image copy in the X, Y, or Z axis of a measurement routine.
Public Method PartProgramMirror2Mirrors the supplied measurement routine. The szPartProgramPathName, szTargetProgramPathName and szReferencePathName should be full path name. If szTargetProgramPathName is empty the default name is used. if DoNotMirrorCAD is true the CAD is not mirrored
Public Method Post

The Post function tells PC-DMIS to import or export Source into Destination. It returns TRUE if the import or export process is successful, FALSE otherwise.

Exactly one of Source and Destination must be a PC-DMIS .prg or .cad file. If it is Source, then PC-DMIS will export based on the name of the Destination file. If the Destination file is a PC-DMIS .prg or .cad file, then PC-DMIS will import based on the name of the Source file.

The Source file must already exist, but the Destination file need not already exist.

Public Method QuitThe Quit function tells PC-DMIS to close. It always returns TRUE.
Public Method RegistryKeyExistsQueries the registry for a specific key
Public Method RegistryValueExistsQueries the registry for a specific value
Public Method RestoreThe Restore subroutine makes the PC-DMIS window open and neither maximized nor minimized.
Public Method SetActiveBrings PC-DMIS to the foreground, making it the active application.
Public Method SpawnNewInstance

 

Public Method SwitchLanguageFilesDeprecated. Switch language resource files from current to expected
Public Method WaitUntilReady

Waits until the online machine has fully initialized or timeout period has elapsed before returning.

Public Method WinHelpInvokes internal help
Public Method WriteRegistryBoolSets a PC-DMIS registry entry to a TRUE or FALSE value.
Public Method WriteRegistryDoubleSets a PC-DMIS registry entry to a specified Double value.
Public Method WriteRegistryDWORDSets a PC-DMIS registry entry to a specified long value.
Public Method WriteRegistryIntSets a PC-DMIS registry entry to a specified integer value. Write Integer.
Public Method WriteRegistryPointSets a PC-DMIS registry entry to a specified XYZ value. Write double.
Public Method WriteRegistrySettings

Writes the current PC-DMIS registry entries and their values to the debug.txt file. 

Public Method WriteRegistryStringThis writes a specified string value to a valid PC-DMIS registry entry. Write String.

Public Properties

Public Property _Name 
Public Property ActivePartProgramRepresents the currently active measurement routine.
Public Property AdminPrivilegesRead Only: Returns true if current user has administrator privileges
Public Property ApplicationEventsReturns the ApplicationObjectEvents object for use in capturing application events.
Public Property ApplicationSettingsReturns the ApplicationSettings object for use in modifying PC-DMIS’s settings.
Public Property AutomationSettingsRead Only: Returns the AutomationSettings Object
Public Property BuildNumberReturns the specific build number for the PC-DMIS application.
Public Property BuildPlatformReturns the build platform (x64 or x86) for the PC-DMIS application.
Public Property BuildTypeReturns the application's build type. Generally this is "QA" (a build from the development source code) or "Release" (a build from the release source code).
Public Property CaptionThe text in the title bar of the application.
Public Property ConnectedInDriveModeRead Only: Returns true when computer connected as driving computer
Public Property ConnectedInRelayModeRead Only: Returns true when computer connected as relay computer
Public Property ConnectedToMasterRead Only: Returns true if connected to master computer as slave
Public Property ConnectedToSlaveRead Only: Returns true if connected to slave computer as master
Public Property CurrentFolderThis property gets or sets the current folder in PC-DMIS. The property only sets a folder if all part programs are closed.
Public Property CurrentLanguageRead Only: Returns the current PCDMIS languages ID
Public Property CurrentUserDirectory

This returns a string showing the directory that contains the current user’s setup information.

Public Property DefaultFilePath

The directory in which the File Open dialog starts. If you set this property to empty it returns the installation path.

Public Property DefaultMachineName

The name of the next available machine for attaching to a measurement routine.

Public Property DefaultProbeFile

The name of the last chosen probe file used when creating a new measurement routine.

Public Property ErrorDialogEnabledRead/Write: Returns/Sets whether the CMM Error Dialog is enabled
Public Property FullNameThe fully qualified path name of the PC-DMIS executable.
Public Property GetBoolSettingRead Only: Returns the boolean value of the named PC-DMIS setting
Public Property GetDoubleSettingRead Only: Returns the double value of the named PC-DMIS setting
Public Property GetDWORDSettingRead Only: Returns the DWORD, or unsigned long, value of the named PC-DMIS setting
Public Property GetIntSettingRead Only: Returns the integer value of the named PC-DMIS setting
Public Property GetStringSettingRead Only: Returns the string value of the named PC-DMIS setting
Public Property Height

The height of the PC-DMIS window in screen pixels.

Public Property IsClosingThis returns True when the PC-DMIS application window quits, through the File | Exit menu item, or when someone closes the application window manually with the x button in the top right.
Public Property LabelTemplatesRead Only: Returns the Label Templates object
Public Property Left

The left edge of the PC-DMIS window, measured from the left edge of the Windows Desktop.

Public Property LmsLicenseRead Only: Returns pointer to Lms License object
Public Property LocaleIDRead Only: Returns the current LocaleID (LCID) of the application
Public Property LockObjectCountThis property returns the number of PC-DMIS automation objects referenced by the automation application or script.
Public Property MachinesReturns the read-only Machines collection object.
Public Property MajorVersion

Returns the major version number of the application.

Public Property MinorVersion

Returns the minor version number of the application.

Public Property Name

The file name of the PC-DMIS executable.

Public Property OperatorMode

Represents whether or not you are in operator mode. TRUE when in operator mode, FALSE otherwise.

Public Property PartProgramsReturns the collection of measurement routines currently active in PC-DMIS as a PartPrograms object.
Public Property PathReturns the directory in which the PC-DMIS executable resides.
Public Property PortLockRead Only: Returns pointer to PortLock object
Public Property ReleaseTypeRead Only: Returns the application release type
Public Property ReleaseTypeNameRead Only: Returns the application release type
Public Property RemotePanelMode

Indicates that PC-DMIS is in Remote Panel mode. Used by Remote Panel Application (RPA).

Public Property ReportTemplatesRead Only: Returns the Report Templates object
Public Property StatusBar

The text on the status bar of the main PC-DMIS window.

Public Property TopThe top edge of the PC-DMIS window, measured from the top edge of the Windows Desktop.
Public Property UserExit

This returns True if the PC-DMIS automation engine is shut down when the user exits PC-DMIS, otherwise this returns False.

Public Property VerboseDialogsRead/Write: Controls verbose debugging dialogs
Public Property VersionString

Returns the version string for the application.

Public Property Visible

TRUE if PC-DMIS is visible, otherwise FALSE.

Public Property Width

The width of the PC-DMIS window in screen pixels.

See Also

Copyright © 2021. Hexagon Manufacturing Intelligence – Metrology Software, Inc. All Rights Reserved.