#AutoIt3Wrapper_AU3Check_Parameters=-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 #include-once ; #INDEX# ======================================================================================================================= ; Title .........: Monarch Automation UDF Library for AutoIt3 ; AutoIt Version : 3.3.6.1++ ; Language ......: English ; Description ...: A collection of functions for working with Monarch. ; Notes .........: For more documentation on Monarch COM programming, see ; http://www.datawatch.com/downloads/Monarch_8_Programmers_Guide.pdf ; Author(s) .....: GMK, mLipok ; =============================================================================================================================== #region Current Functions ======================================================================================================= #cs Monarch Object Functions _Monarch_Create _Monarch_Exit #ce Monarch Object Functions #cs Monarch Character Set Functions _Monarch_SetInputCharacterSet _Monarch_SetOutputCharacterSet #ce Monarch Character Set Functions #cs Monarch Log File Functions _Monarch_SetLogFile _Monarch_WriteToLogFile #ce Monarch Log File Functions #cs Monarch Data Source Functions _Monarch_CloseAllDocuments _Monarch_OpenDatabase _Monarch_SetDataSourcePassword _Monarch_SetJoinPassword _Monarch_SetProjectFile _Monarch_SetReportFile #ce Monarch Data Source Functions #cs Monarch Data Functions _Monarch_FindText _Monarch_SetFieldVisible #ce #cs Monarch Model Functions _Monarch_GetCurrentModel _Monarch_SetCurrentModel _Monarch_SetModelFile _Monarch_SetRuntimeParameter #ce Monarch Model Functions #cs Monarch View Functions _Monarch_SetFirstView _Monarch_SetView #ce Monarch View Functions #cs Monarch Filter Functions _Monarch_FilterCount _Monarch_GetCurrentFilter _Monarch_GetFilterNameAt _Monarch_GetFilters _Monarch_SetCurrentFilter #ce Monarch Filter Functions #cs Monarch Sort Functions _Monarch_GetCurrentSort _Monarch_SetCurrentSort _Monarch_GetSortNameAt _Monarch_GetSortNameList _Monarch_SortCount #ce Monarch Sort Functions #cs Monarch Summary Functions _Monarch_GetCurrentSummary _Monarch_GetSummaryNameAt _Monarch_GetSummaryNameList _Monarch_SetCurrentSummary _Monarch_SummaryCount #ce Monarch Summary Functions #cs Monarch Print Functions _Monarch_PrintReport _Monarch_PrintSummary _Monarch_PrintTable #ce Monarch Print Functions #cs Monarch Export Functions _Monarch_ExportSummary _Monarch_ExportTable _Monarch_JetExportSummary _Monarch_JetExportTable _Monarch_RunAllExports _Monarch_RunExport _Monarch_SetTextAppend #ce Monarch Export Functions #cs Monarch PRF Functions _Monarch_GetCurrentPRFModel _Monarch_SetCurrentPRFModel _Monarch_PRFPublish _Monarch_SetPRFFile #ce Monarch PRF Functions #cs Monarch Misc. Functions _Monarch_DisplayWindow _Monarch_Version _Monarch_ComErrorHandler_UserFunction #ce #endregion Current Functions ==================================================================================================== #region VARIABLES =============================================================================================================== Global $MonarchPath = RegRead("HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\Monarch.exe", "") Global $ModelPath = RegRead("HKCU\Software\Datawatch\Monarch Pro\Settings", "ModelPath") Global Enum _; Error Status Types $_MonarchStatus_Success = 0, _ $_MonarchStatus_GeneralError, _ $_MonarchStatus_InvalidDataType, _ $_MonarchStatus_InvalidValue, _ $_MonarchStatus_NoMatch Global Enum _ $_MONARCH_EXT_DEFAULT, _ ; Default - Do not return any additional information, The extended which is not specifically defined. $_MONARCH_EXT_PARAM1, _ ; Error Occurs in 1-Parameter $_MONARCH_EXT_PARAM2, _ ; Error Occurs in 2-Parameter $_MONARCH_EXT_PARAM3, _ ; Error Occurs in 3-Parameter $_MONARCH_EXT_PARAM4, _ ; Error Occurs in 4-Parameter $_MONARCH_EXT_PARAM5, _ ; Error Occurs in 5-Parameter $_MONARCH_EXT_PARAM6 ; Error Occurs in 6-Parameter #endregion VARIABLES =========================================================================================================== #region Core Functions ========================================================================================================== ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_Create ; Description ...: Creates a Monarch object ; Syntax ........: _Monarch_Create([$fAttach = False]) ; Parameters ....: $fAttach - [optional] Attach to an existing Monarch32 object. Default is False. ; Return values .: On Success - Returns Monarch object ; On Failure - Returns 0 and sets @error: ; |@error - 1 ($_MonarchStatus_GeneralError) = General Error ; | - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_Create($fAttach = False) If Not IsBool($fAttach) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $oObject If $fAttach Then $oObject = ObjGet("Monarch32") If @error Then Return SetError($_MonarchStatus_GeneralError, $_MONARCH_EXT_DEFAULT, 0) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $oObject) EndIf $oObject = ObjCreate("Monarch32") If @error Then Return SetError(2, 0, 0) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $oObject) EndFunc ;==>_Monarch_Create ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_Exit ; Description ...: Closes all open report files, model files, the log file and terminates the Monarch session ; Syntax ........: _Monarch_Exit(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_Exit(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) $oObject.Exit Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_Exit ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_DisplayWindow ; Description ...: Gives the current Monarch window focus and optionally changes the size of the window ; Syntax ........: _Monarch_DisplayWindow(ByRef $oObject, $iSize) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $iSize - Size ; |$iSize = 0 - Window is maximized ; |$iSize = 1 - Window is restored ; |$iSize = 2 - Window is minimized ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_DisplayWindow(ByRef $oObject, $iSize) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsInt($iSize) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If $iSize < 0 Or $iSize > 2 Then SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.DisplayWindow($iSize) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_DisplayWindow ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetInputCharacterSet ; Description ...: Establishes the character set, ANSI or ASCII, for interpreting report data that is loaded via the _Monarch_SetReportFile function ; Syntax ........: _Monarch_SetInputCharacterSet(ByRef $oObject, $sCharacterSet) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sCharacterSet - Character Set (As String) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetInputCharacterSet(ByRef $oObject, $sCharacterSet) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sCharacterSet) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) $sCharacterSet = StringUpper($sCharacterSet) If $sCharacterSet <> "ANSI" And $sCharacterSet <> "ASCII" Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.SetInputCharacterSet($sCharacterSet) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetInputCharacterSet ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetOutputCharacterSet ; Description ...: Establishes the character set, ANSI or ASCII, for interpreting report data that is loaded via the _Monarch_SetReportFile function ; Syntax ........: _Monarch_SetOutputCharacterSet(ByRef $oObject, $sCharacterSet) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sCharacterSet - Character Set (As String) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetOutputCharacterSet(ByRef $oObject, $sCharacterSet) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sCharacterSet) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) $sCharacterSet = StringUpper($sCharacterSet) If $sCharacterSet <> "ANSI" And $sCharacterSet <> "ASCII" Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.SetOutputCharacterSet($sCharacterSet) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetOutputCharacterSet ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetLogFile ; Description ...: Establishes the file specified as LogFile as a log file for Monarch error and export messages ; Syntax ........: _Monarch_SetLogFile(ByRef $oObject, $sLogFile, $fAppendFlag) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sLogFile - Log file (As String) ; $fAppendFlag - Append to log file? (As Boolean) ; Return values .: On Success - Boolean TRUE if the log file was established successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetLogFile(ByRef $oObject, $sLogFile, $fAppendFlag) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sLogFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not FileExists($sLogFile) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) If Not IsBool($fAppendFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) Local $fReturn = $oObject.SetLogFile($sLogFile, $fAppendFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_SetLogFile ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_WriteToLogFile ; Description ...: Writes the specified string to the currently established log file ; Syntax ........: _Monarch_WriteToLogFile(ByRef $oObject, $sUserLogInfo) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sUserLogInfo - User log info (As String) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_WriteToLogFile(ByRef $oObject, $sUserLogInfo) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sUserLogInfo) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) $oObject.WriteToLogFile($sUserLogInfo) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_WriteToLogFile ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_CloseAllDocuments ; Description ...: Closes all open report files and model files ; Syntax ........: _Monarch_CloseAllDocuments(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_CloseAllDocuments(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) $oObject.CloseAllDocuments() Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_CloseAllDocuments ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_OpenDatabase ; Description ...: Opens an ISAM database file or an ODBC data source ; Syntax ........: _Monarch_OpenDatabase(ByRef $oObject, $sConnectString, $sPassword, $sTable, $sModel) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sConnectString - Connect string (As String) ; $sPassword - Password (As String) ; $sTable - Table or View (As String) ; $sModel - Model (As String) ; Return values .: On Success - Boolean TRUE if the database was opened successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_OpenDatabase(ByRef $oObject, $sConnectString, $sPassword, $sTable, $sModel) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sConnectString) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not IsString($sPassword) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) If StringLen($sPassword) > 32 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM3, 0) If Not IsString($sTable) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM4, 0) If Not IsString($sModel) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM5, 0) If Not FileExists($sModel) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM5, 0) Local $fReturn = $oObject.OpenDatabase($oObject, $sConnectString, $sPassword, $sTable, $sModel) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_OpenDatabase ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetDataSourcePassword ; Description ...: Sets the password for an external lookup specified by $sLookupName ; Syntax ........: _Monarch_SetDataSourcePassword(ByRef $oObject, $sLookupName, $sPassword) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sLookupName - Lookup name (As String) ; $sPassword - Password (As String) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetDataSourcePassword(ByRef $oObject, $sLookupName, $sPassword) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sLookupName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not IsString($sPassword) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) $oObject.SetDataSourcePassword($sLookupName, $sPassword) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetDataSourcePassword ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetJoinPassword ; Description ...: Establishes the password to be used when opening a password protected data source ; Syntax ........: _Monarch_SetJoinPassword(ByRef $oObject, $sPassword) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sPassword - Password (As String) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 3 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetJoinPassword(ByRef $oObject, $sPassword) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sPassword) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If StringLen($sPassword) > 32 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.SetJoinPassword($sPassword) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetJoinPassword ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetProjectFile ; Description ...: Opens the Project (XPRJ/PRJ) file specified by $sProjectFile for processing ; Syntax ........: _Monarch_SetProjectFile(ByRef $oObject, $sProjectFile) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sProjectFile - Project file (As String) ; Return values .: On Success - If the report file(s) and model file referenced by the project or PRF file are all ; successfully opened, the method returns a value of boolean TRUE. Otherwise, it returns a value ; of FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetProjectFile(ByRef $oObject, $sProjectFile) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sProjectFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not FileExists($sProjectFile) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) Local $fReturn = $oObject.SetProjectFile($sProjectFile) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_SetProjectFile ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetReportFile ; Description ...: Opens the report file specified by $sReportFile for processing ; Syntax ........: _Monarch_SetReportFile(ByRef $oObject, $sReportFile, $fAddFlag) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sReportFile - Report File (As String) ; $fAddFlag - Add to list of open reports? (As boolean) ; Return values .: On Success - Boolean TRUE if the file was opened successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetReportFile(ByRef $oObject, $sReportFile, $fAddFlag) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sReportFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not FileExists($sReportFile) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) If Not IsBool($fAddFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) Local $fReturn = $oObject.SetReportFile($sReportFile, $fAddFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_SetReportFile ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_FindText ; Description ...: Finds an occurrence (first or next) of the SearchText string ; Syntax ........: _Monarch_FindText(ByRef $oObject, $fOccurrenceFlag, $sSearchText, $fMatchCaseFlag, $fAllDocsFlag) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $fOccurrenceFlag - Search at top? (As Boolean) ; $sSearchText - Text for which to search (As string) ; $fMatchCaseFlag - Perform case-sensitive search? (As Boolean) ; $fAllDocsFlag - Search all documents? (As Boolean) ; Return values .: On Success - Boolean True if the string was found, otherwise returns False ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_FindText(ByRef $oObject, $fOccurrenceFlag, $sSearchText, $fMatchCaseFlag, $fAllDocsFlag) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsBool($fOccurrenceFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not IsString($sSearchText) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) If StringLen($sSearchText) > 128 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM3, 0) If Not IsBool($fMatchCaseFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM4, 0) If Not IsBool($fAllDocsFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM5, 0) Local $fReturn = $oObject.FindText($fOccurrenceFlag, $sSearchText, $fMatchCaseFlag, $fAllDocsFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_FindText ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetFieldVisible ; Description ...: Specifies whether a hidden field is displayed or not ; Syntax ........: _Monarch_SetFieldVisible(ByRef $oObject, $sFieldName, $fVisibleFlag) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sFieldName - Field name (As String) ; $fVisibleFlag - Set field visible? (As Boolean) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetFieldVisible(ByRef $oObject, $sFieldName, $fVisibleFlag) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sFieldName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If StringLen($sFieldName) > 62 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) If Not IsBool($fVisibleFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) $oObject.SetFieldVisible($sFieldName, $fVisibleFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetFieldVisible ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetCurrentModel ; Description ...: Returns the name of a currently active model ; Syntax ........: _Monarch_GetCurrentModel(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the name of the active model ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetCurrentModel(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $sReturn = $oObject.CurrentModel Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetCurrentModel ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetCurrentModel ; Description ...: Sets the name of a currently active model ; Syntax ........: _Monarch_SetCurrentModel(ByRef $oObject, $sModelName) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sModelName - Model name (As string) ; Return values .: On Success - Returns 1 and sets the current model ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetCurrentModel(ByRef $oObject, $sModelName) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sModelName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If StringLen($sModelName) > 256 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.CurrentModel = $sModelName Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetCurrentModel ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetModelFile ; Description ...: Opens the Model file specified by $sModelFile for processing ; Syntax ........: _Monarch_SetModelFile(ByRef $oObject, $sModelFile) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sModelFile - Model File (As String) ; Return values .: On Success - Boolean TRUE if the file was opened successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetModelFile(ByRef $oObject, $sModelFile) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sModelFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not FileExists($sModelFile) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) Local $fReturn = $oObject.SetModelFile($sModelFile) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_SetModelFile ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetRuntimeParameter ; Description ...: Set Monarch runtime parameter ; Syntax ........: _Monarch_SetRuntimeParameter(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetRuntimeParameter(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) $oObject.SetRuntimeParameter Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetRuntimeParameter ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetFirstView ; Description ...: Specifies which Monarch window will be displayed the first time that a window is invoked ; Syntax ........: _Monarch_SetFirstView(ByRef $oObject, $sWindowType) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sWindowType - Window type (As String) ; |"T" = Table ; |"S" = Summary ; |"R" = Report ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetFirstView(ByRef $oObject, $sWindowType) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sWindowType) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not StringLen($sWindowType) = 1 And Not StringRegExp($sWindowType, "(?i)[rst]") Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.SetFirstView(StringUpper($sWindowType)) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetFirstView ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetView ; Description ...: Set Monarch view ; Syntax ........: _Monarch_SetView(ByRef $oObject, $sWindowType) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sWindowType - Window type (As String) ; |"T" = Table ; |"S" = Summary ; |"R" = Report ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetView(ByRef $oObject, $sWindowType) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sWindowType) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not StringLen($sWindowType) = 1 And Not StringRegExp($sWindowType, "(?i)[rst]") Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.SetView(StringUpper($sWindowType)) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetView ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_FilterCount ; Description ...: Returns the total number of filter definitions available in the currently open model file ; Syntax ........: _Monarch_FilterCount(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the total number of filter definitions available in the currently open model file ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_FilterCount(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $iReturn = $oObject.FilterCount Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $iReturn) EndFunc ;==>_Monarch_FilterCount ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetCurrentFilter ; Description ...: Returns the name of the currently active filter definition ; Syntax ........: _Monarch_GetCurrentFilter(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the name of the active filter in currently opened model or project file ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetCurrentFilter(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $sReturn = $oObject.CurrentFilter Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetCurrentFilter ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetFilters ; Description ...: Returns an array of all filters in the current model ; Syntax ........: _Monarch_GetFilters(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns an array of all filters in the current model ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetFilters(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $iFilterCount = _Monarch_FilterCount($oObject) Local $aReturn[$iFilterCount] For $iCounter = 0 To $iFilterCount - 1 $aReturn[$iCounter] = _Monarch_GetFilterNameAt($oObject, $iCounter) Next Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $aReturn) EndFunc ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetCurrentFilter ; Description ...: Sets the name of the currently active filter definition ; Syntax ........: _Monarch_SetCurrentFilter(ByRef $oObject, $sFilterName) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sFilterName - Filter name (As string) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetCurrentFilter(ByRef $oObject, $sFilterName) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sFilterName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If StringLen($sFilterName) > 31 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) Local $aFilters = _Monarch_GetFilters($oObject) If @error Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) Local $iLastFilter = UBound($aFilters) - 1 Local $bValidFilter = False For $iFilter = 0 To $iLastFilter If $aFilters[$iFilter] == $sFilterName Then $bValidFilter = True ExitLoop EndIf Next If Not $bValidFilter Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) $oObject.CurrentFilter = $sFilterName Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetCurrentFilter ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetFilterNameAt ; Description ...: Returns the name of the nth filter from within the currently open model ; Syntax ........: _Monarch_GetFilterNameAt(ByRef $oObject, $iIndex) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $iIndex - Index (As integer) ; Return values .: On Success - If no model is open or if there are no filter definitions established for the currently open ; model, the method returns an empty string. Otherwise, the method will return a string (up to ; 31 characters) representing the name of the specified filter. ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetFilterNameAt(ByRef $oObject, $iIndex) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsInt($iIndex) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If $iIndex < 0 Or $iIndex > $oObject.FilterCount - 1 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) Local $sReturn = $oObject.GetFilterNameAt($iIndex) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetFilterNameAt ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetCurrentSort ; Description ...: Retrieves the name of the currently active sort definition ; Syntax ........: _Monarch_GetCurrentSort(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the name of the currently active sort definition ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetCurrentSort(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $sReturn = $oObject.GetCurrentSort Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetCurrentSort ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetCurrentSort ; Description ...: Sets the name of the currently active sort definition ; Syntax ........: _Monarch_SetCurrentSort(ByRef $oObject, $sSortName) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sSortName - Sort name (As String) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 3 ($_MonarchStatus_InvalidValue) = Invalid Value ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetCurrentSort(ByRef $oObject, $sSortName) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sSortName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If StringLen($sSortName) > 31 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) Local $aSortNames = _Monarch_GetSortNameList($oObject) If @error Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) Local $iLastSortName = UBound($aSortNames) - 1 Local $bValidSortName = False For $iSortName = 0 To $iLastSortName If $aSortNames[$iSortName] == $sSortName Then $bValidSortName = True ExitLoop EndIf Next If Not $bValidSortName Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) $oObject.CurrentSort = $sSortName Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetCurrentSort ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetSortNameAt ; Description ...: Returns the name of the nth sort definition in the currently open model ; Syntax ........: _Monarch_GetSortNameAt(ByRef $oObject, $iIndex) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $iIndex - Index (as integer) ; Return values .: On Success - If no model is open or if there are no sort definitions established for the currently open ; model, the method returns an empty string. Otherwise, the method returns a string (up to 31 ; characters) representing the name of the specified sort definition. ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 3 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetSortNameAt(ByRef $oObject, $iIndex) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsInt($iIndex) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If $iIndex < 0 Or $iIndex > $oObject.SortCount - 1 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) Local $sReturn = $oObject.GetSortNameAt($iIndex) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetSortNameAt ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetSortNameList ; Description ...: Returns an array containing the sort names ; Syntax ........: _Monarch_GetSortNameList(ByRef $oObject, $iIndex) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns an array containing the Sort names with $avReturn[0] containing the number of summaries ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetSortNameList(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $avReturn[$oObject.SortCount + 1] $avReturn[0] = $oObject.SortCount For $iIndex = 0 to $avReturn[0] - 1 $avReturn[$iIndex + 1] = $oObject.GetSortNameAt($iIndex) Next Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $avReturn) EndFunc ;==>_Monarch_GetSortNameList ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SortCount ; Description ...: Returns the total number of sort definitions available in the currently open model file ; Syntax ........: _Monarch_SortCount(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the total number of sort definitions available in the currently open model file ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SortCount(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $iReturn = $oObject.SortCount Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $iReturn) EndFunc ;==>_Monarch_SortCount ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetCurrentSummary ; Description ...: Returns the name of the currently active summary definition ; Syntax ........: _Monarch_GetCurrentSummary(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the active Summary in currently opened model or project file ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetCurrentSummary(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $sReturn = $oObject.GetCurrentSummary Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetCurrentSummary ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetCurrentSummary ; Description ...: Sets the name of the currently active summary definition ; Syntax ........: _Monarch_SetCurrentSummary(ByRef $oObject, $sSummaryName) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sSummaryName - Summary name (As String) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetCurrentSummary(ByRef $oObject, $sSummaryName) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sSummaryName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If StringLen($sSummaryName) > 31 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) Local $aSummaryNames = _Monarch_GetSummaryNameList($oObject) If @error Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) Local $iLastSummaryName = UBound($aSummaryNames) - 1 Local $bValidSummaryName = False For $iSummaryName = 0 To $iLastSummaryName If $aSummaryNames[$iSummaryName] == $sSummaryName Then $bValidSummaryName = True ExitLoop EndIf Next If Not $bValidSummaryName Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) $oObject.CurrentSummary = $sSummaryName Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetCurrentSummary ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetSummaryNameAt ; Description ...: Returns the name of the nth summary definition in the currently open model ; Syntax ........: _Monarch_GetSummaryNameAt(ByRef $oObject, $iIndex) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $iIndex - Index (as integer) ; Return values .: On Success - If no model is open or if there are no summary definitions established for the currently open ; model, the method returns an empty string. Otherwise, the method returns a string (up to 31 ; characters) representing the name of the specified summary definition. ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 3 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetSummaryNameAt(ByRef $oObject, $iIndex) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsInt($iIndex) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If $iIndex < 0 Or $iIndex > $oObject.SummaryCount - 1 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) Local $sReturn = $oObject.GetSummaryNameAt($iIndex) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetSummaryNameAt ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetSummaryNameList ; Description ...: Returns an array containing the summary names ; Syntax ........: _Monarch_GetSummaryNameList(ByRef $oObject, $iIndex) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns an array containing the summary names with $avArray[0] containing the number of summaries ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetSummaryNameList(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $avReturn[$oObject.SummaryCount + 1] $avReturn[0] = $oObject.SummaryCount For $iIndex = 0 to $avReturn[0] - 1 $avReturn[$iIndex + 1] = $oObject.GetSummaryNameAt($iIndex) Next Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $avReturn) EndFunc ;==>_Monarch_GetSummaryNameList ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SummaryCount ; Description ...: Returns the total number of summary definitions available in the currently open model file ; Syntax ........: _Monarch_SummaryCount(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the total number of summary definitions available in the currently open model file ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SummaryCount(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $iReturn = $oObject.SummaryCount Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $iReturn) EndFunc ;==>_Monarch_SummaryCount ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_PrintReport ; Description ...: Sends the contents of the Report view to the printer ; Syntax ........: _Monarch_PrintReport(ByRef $oObject[, $fDirectPrintFlag = True]) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $fDirectPrintFlag - Use default printer settings? (As boolean) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_PrintReport(ByRef $oObject, $fDirectPrintFlag = True) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsBool($fDirectPrintFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) $oObject.PrintReport($fDirectPrintFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_PrintReport ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_PrintSummary ; Description ...: Sends the contents of the Summary view to the printer ; Syntax ........: _Monarch_PrintSummary(ByRef $oObject[, $fDirectPrintFlag = True]) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $fDirectPrintFlag - Use default printer settings? (As boolean) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_PrintSummary(ByRef $oObject, $fDirectPrintFlag = True) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsBool($fDirectPrintFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) $oObject.PrintSummary($fDirectPrintFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_PrintSummary ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_PrintTable ; Description ...: Sends the contents of the Table view to the printer ; Syntax ........: _Monarch_PrintTable(ByRef $oObject[, $fDirectPrintFlag = True]) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $fDirectPrintFlag - Use default printer settings? (As boolean) ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_PrintTable(ByRef $oObject, $fDirectPrintFlag = True) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsBool($fDirectPrintFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) $oObject.PrintTable($fDirectPrintFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_PrintTable ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_ExportSummary ; Description ...: Performs an export from the Summary window using the Monarch V3 engine ; Syntax ........: _Monarch_ExportSummary(ByRef $oObject, $sExportFile) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sExportFile - Export file (As String) ; Return values .: On Success - Boolean True if the export completed successfully, otherwise returns False ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_ExportSummary(ByRef $oObject, $sExportFile) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sExportFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) Local $fReturn = $oObject.ExportSummary($sExportFile) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_ExportSummary ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_ExportTable ; Description ...: Performs an export from the Table window using the Monarch V3 engine ; Syntax ........: _Monarch_ExportTable(ByRef $oObject, $sExportFile) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sExportFile - Export file (As String) ; Return values .: On Success - Boolean True if the export completed successfully, otherwise returns False ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_ExportTable(ByRef $oObject, $sExportFile) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sExportFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) Local $fReturn = $oObject.ExportTable($sExportFile) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_ExportTable ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_JetExportSummary ; Description ...: Causes the data to be exported from the Summary window and written to the file ExportFile, to the table specified by $sTableName ; Syntax ........: _Monarch_JetExportSummary(ByRef $oObject, $sExportFile, $sTableName, $iAppendFlag) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sExportFile - Export file (As String) ; $sTableName - Table name (As String) ; $iAppendFlag - Append flag: ; |0 = Overwrite ; |1 = New table or sheet ; |2 = Append to existing table or sheet ; Return values .: On Success - Boolean TRUE if the export completed successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_JetExportSummary(ByRef $oObject, $sExportFile, $sTableName, $iAppendFlag) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sExportFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not IsString($sTableName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) If Not IsInt($iAppendFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM4, 0) If $iAppendFlag < 0 Or $iAppendFlag > 2 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM4, 0) Local $fReturn = $oObject.JetExportSummary($sExportFile, $sTableName, $iAppendFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_JetExportSummary ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_JetExportTable ; Description ...: Causes the data to be exported from the Table window and written to the file ExportFile, to the table specified by $sTableName ; Syntax ........: _Monarch_JetExportTable(ByRef $oObject, $sExportFile, $sTableName, $iAppendFlag) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sExportFile - Export file (As String) ; $sTableName - Table name (As String) ; $iAppendFlag - Append flag: ; |0 = Overwrite ; |1 = New table or sheet ; |2 = Append to existing table or sheet ; Return values .: On Success - Boolean TRUE if the export completed successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_JetExportTable(ByRef $oObject, $sExportFile, $sTableName, $iAppendFlag) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sExportFile) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not IsString($sTableName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) If Not IsInt($iAppendFlag) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM4, 0) If $iAppendFlag < 0 Or $iAppendFlag > 2 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM4, 0) Local $fReturn = $oObject.JetExportTable($sExportFile, $sTableName, $iAppendFlag) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_JetExportTable ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_RunAllExports ; Description ...: Executes all Project Exports in the currently loaded Project ; Syntax ........: _Monarch_RunAllExports(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Boolean TRUE if the exports were performed successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_RunAllExports(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $fReturn = $oObject.RunAllExports() Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_RunAllExports ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_RunExport ; Description ...: Executes a Project Export of the name specified in $sProjectExportName in the currently loaded Project ; Syntax ........: _Monarch_RunExport(ByRef $oObject, $sProjectExportName) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sProjectExportName - Project export name (As String) ; Return values .: On Success - Boolean TRUE if the export was performed successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_RunExport(ByRef $oObject, $sProjectExportName) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sProjectExportName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not FileExists($sProjectExportName) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) Local $fReturn = $oObject.RunExport($sProjectExportName) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_RunExport ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetTextAppend ; Description ...: Set text append ; Syntax ........: _Monarch_SetTextAppend(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns 1 ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetTextAppend(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) $oObject.SetTextAppend Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetTextAppend ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_GetCurrentPRFModel ; Description ...: Returns the name of the model in the currently active Portable report File (PRF) ; Syntax ........: _Monarch_GetCurrentPRFModel(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns the name of the active PRFModel ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_GetCurrentPRFModel(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $sReturn = $oObject.CurrentPRFModel Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_GetCurrentPRFModel ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetCurrentPRFModel ; Description ...: Sets the name of the model in the currently active Portable report File (PRF) ; Syntax ........: _Monarch_SetCurrentPRFModel(ByRef $oObject, $sPRFModelName) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sPRFModelName - PRFModel name (As String) ; Return values .: On Success - Returns 1 and sets the current PRFModel ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetCurrentPRFModel(ByRef $oObject, $sPRFModelName) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sPRFModelName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If StringLen($sPRFModelName) > 256 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM2, 0) $oObject.CurrentPRFModel = $sPRFModelName Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, 1) EndFunc ;==>_Monarch_SetCurrentPRFModel ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_PRFPublish ; Description ...: Publishes a portable report file (PRF) from a currently open report and model. ; Syntax ........: _Monarch_PRFPublish(ByRef $oObject, $sPublishFileName, $fIncludeTree, $fIncludeModel, $iIncludeTable, $fEncrypt) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sPublishFileName - PRF output file (As String) ; $fIncludeTree - Include navigation tree? (As Boolean) ; $fIncludeModel - Include model file? (As Boolean) ; $iIncludeTable - Include Table (As Integer) ; |0 = Excludes internal database ; |>0 = Includes internal database ; $fEncrypt - Encrypt file? (As Boolean) ; Return values .: On Success - Boolean TRUE if the publish completed successfully, otherwise returns FALSE ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 2 ($_MonarchStatus_InvalidValue) = Invalid Value ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_PRFPublish(ByRef $oObject, $sPublishFileName, $fIncludeTree, $fIncludeModel, $iIncludeTable, $fEncrypt) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sPublishFileName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not FileExists($sPublishFileName) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) If Not IsBool($fIncludeTree) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) If Not IsBool($fIncludeModel) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM4, 0) If Not IsInt($iIncludeTable) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM5, 0) If $iIncludeTable < 0 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM5, 0) If Not IsBool($fEncrypt) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM6, 0) Local $fReturn = $oObject.PRFPublish($sPublishFileName, $fIncludeTree, $fIncludeModel, $iIncludeTable, $fEncrypt) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_PRFPublish ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_SetPRFFile ; Description ...: Opens the portable report file specified by $sFileName for processing ; Syntax ........: _Monarch_SetPRFFile(ByRef $oObject, $sFileName[, $sPassword = ""]) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; $sFileName - File name (As String) ; $sPassword - Password (As String) (Optional) ; Return values .: On Success - Boolean TRUE if the file was opened successfully, otherwise returns FALSE. If the wrong password ; is entered, SetPrfFile returns FALSE and the PRF file is not opened ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; | - 3 ($_MonarchStatus_InvalidValue) = Invalid Value ; | - 4 ($_MonarchStatus_NoMatch) = No Match ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_SetPRFFile(ByRef $oObject, $sFileName, $sPassword = "") If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) If Not IsString($sFileName) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM2, 0) If Not FileExists($sFilename) Then Return SetError($_MonarchStatus_NoMatch, $_MONARCH_EXT_PARAM2, 0) If Not IsString($sPassword) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM3, 0) If StringLen($sPassword) > 32 Then Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM3, 0) Local $fReturn = $oObject.SetPRFFile($sFileName, $sPassword) Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fReturn) EndFunc ;==>_Monarch_SetPRFFile ; #FUNCTION# ==================================================================================================================== ; Name ..........: _Monarch_Version ; Description ...: Returns installed version of Monarch ; Syntax ........: _Monarch_Version(ByRef $oObject) ; Parameters ....: $oObject - Object variable of a Monarch32 or Window object ; Return values .: On Success - Returns installed version of Monarch ; On Failure - Returns 0 and sets @error: ; |@error - 2 ($_MonarchStatus_InvalidDataType) = Invalid Data Type ; |@extended - Number of offending parameter ; Author ........: GMK ; =============================================================================================================================== Func _Monarch_Version(ByRef $oObject) If Not IsObj($oObject) Then Return SetError($_MonarchStatus_InvalidDataType, $_MONARCH_EXT_PARAM1, 0) Local $sReturn = $oObject.Version Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $sReturn) EndFunc ;==>_Monarch_Version ; #FUNCTION# ==================================================================================================================== ; Name ..........: __Monarch_ComErrorHandler_UserFunction ; Description ...: Set a UserFunctionWrapper to move the Fired COM Error Error outside UDF ; Syntax ........: _Monarch_ComErrorHandler_UserFunction([$fnUserFunction = Default]) ; Parameters ....: $fnUserFunction- [optional] a Function. Default value is Default. ; Return values .: ErrorHandler Function ; Author ........: mLipok ; Modified ......: ; Remarks .......: ; Related .......: ; Link ..........: ; Example .......: No ; =============================================================================================================================== Func _Monarch_ComErrorHandler_UserFunction($fnUserFunction = Default) ; in case when user does not set function UDF, must use internal function to avoid AutoItError Local Static $fnUserFunction_Static = '' If $fnUserFunction = Default Then ; just return stored static variable Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fnUserFunction_Static) ElseIf IsFunc($fnUserFunction) Then ; set and return static variable $fnUserFunction_Static = $fnUserFunction Return SetError($_MonarchStatus_Success, $_MONARCH_EXT_DEFAULT, $fnUserFunction_Static) Else ; reset static variable $fnUserFunction_Static = '' ; return error as incorrect parameter was passed to this function Return SetError($_MonarchStatus_InvalidValue, $_MONARCH_EXT_PARAM1, $fnUserFunction_Static) EndIf EndFunc ;==>_Monarch_ComErrorHandler_UserFunction #endregion Core Functions ========================================================================================================== #region Internal Functions ========================================================================================================= ; #INTERNAL_USE_ONLY#========================================================== ; Name ..........: __Monarch_ComErrorHandler_InternalFunction ; Description ...: A COM error handling routine. ; Syntax.........: __Monarch_ComErrorHandler_InternalFunction() ; Parameters ....: None ; Return values .: None ; Author ........: mLipok ; Modified ......: ; Remarks .......: ; Related .......: ; Link ..........; ; Example .......; [yes/no] ; ============================================================================== Func __Monarch_ComErrorHandler_InternalFunction(ByRef $oCOMError) ; If not defined ComErrorHandler_UserFunction then this function do nothing special ; In that case you only can check @error / @extended after suspect functions Local $sUserFunction = _Monarch_ComErrorHandler_UserFunction() If IsFunc($sUserFunction) Then $sUserFunction($oCOMError) EndFunc ;==>__Monarch_ComErrorHandler_InternalFunction #endregion Internal Functions ===================================================================================================