GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

5.21 Last Error Functions

5.21.1 GetLastError Function 

As SDK functions operate, they may place extended data in a static value for the last error. This can include details of the reason why a function failed. The GetLastError function will return extended error information in the form of an integer error code. These error codes may be Legato defines or defined in the Windows SDK. Every Legato function call will cause the GetLastError function to reset with the exception of calling the GetLastError and GetLastErrorMessage functions.

5.21.2 GetLastErrorMessage Function

Some functions may generate contextual error information in addition to a formatted error code on failure. This error text can be retrieved with the GetLastErrorMessage function and can be useful in providing additional or more specific information on why a function produced the error. Every Legato function call will cause the GetLastError function to reset with the exception of calling the GetLastError and GetLastErrorMessage functions.

5.21.3 Last Log Functions

Some functions may generate log information on failure or during normal operation. Log handles can be retrieved using the GetLastErrorLog and GetLastDefaultLog functions.

5.21.4 SetLastError Function

Functions can use the SetLastError function to return additional error information in the same manner as the SDK function.

5.21.5 Functions

GetLastDefaultLog — Returns a handle to the default output log for the last operation, if available.

GetLastError — Gets the last error code, if available.

GetLastErrorLog — Returns a handle to the default error log for the last operation, if available.

GetLastErrorMessage — Returns the last error message, if available.

SetLastError — Sets the last error code and optionally, the message.

IsCancel — Checks the value to see if it is a cancel error code (ERROR_CANCEL) or 2 (IDCANCEL).

IsError — Checks the value to see if the supplied value matches an error condition.

IsNotError — Checks the value to see if the supplied value does not match an error condition.

TranslateFormattedErrorCode — Translates a formatted error code to a string.

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.