Difference between revisions of "Unit GlobalConst"
From Ultibo.org
								
												
				| Line 9: | Line 9: | ||
=== Constants ===  | === Constants ===  | ||
----  | ----  | ||
| + | |||
| + | |||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Universal error constants''' <code> ERROR_* </code></div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | | <code>ERROR_SUCCESS = 0;</code>  | ||
| + | | Success  | ||
| + | |-  | ||
| + | | <code>NO_ERROR = 0;</code>  | ||
| + | | Success  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_FUNCTION = 1;</code>      | ||
| + | | Invalid function  | ||
| + | |-  | ||
| + | | <code>ERROR_FILE_NOT_FOUND = 2;</code>      | ||
| + | | The file cannot be found  | ||
| + | |-  | ||
| + | | <code>ERROR_PATH_NOT_FOUND = 3;</code>      | ||
| + | | The path cannot be found  | ||
| + | |-  | ||
| + | | <code>ERROR_TOO_MANY_OPEN_FILES = 4;</code>      | ||
| + | | Too many open files  | ||
| + | |-  | ||
| + | | <code>ERROR_ACCESS_DENIED = 5;</code>      | ||
| + | | Access is denied  | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_HANDLE = 6;</code>      | ||
| + | | Invalid handle}  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_ENOUGH_MEMORY = DWORD(8);</code>    | ||
| + | | Not enough storage is available to process this command  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_ACCESS = 12;</code>     | ||
| + | | Invalid access  | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_DATA = 13;</code>     | ||
| + | | The data is invalid  | ||
| + | |-  | ||
| + | | <code>ERROR_OUTOFMEMORY = 14;</code>     | ||
| + | | Not enough memory is available  | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_DRIVE = 15;</code>     | ||
| + | | Cannot find the drive specified  | ||
| + | |-  | ||
| + | | <code>ERROR_CURRENT_DIRECTORY = 16;</code>     | ||
| + | | Current directory cannot be removed  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_SAME_DEVICE = 17;</code>     | ||
| + | | Cannot move the file to a different disk drive  | ||
| + | |-  | ||
| + | | <code>ERROR_NO_MORE_FILES = 18;</code>     | ||
| + | | There are no more files  | ||
| + | |-  | ||
| + | | <code>ERROR_WRITE_PROTECT = 19;</code>     | ||
| + | | Media is write protected  | ||
| + | |-  | ||
| + | | <code>ERROR_BAD_UNIT = 20;</code>     | ||
| + | | Cannot find the device specified  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_READY = 21;</code>     | ||
| + | | The device is not ready  | ||
| + | |-  | ||
| + | | <code>ERROR_BAD_COMMAND = 22;</code>     | ||
| + | | The device does not recognise the command  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_WRITE_FAULT = 29;</code>     | ||
| + | | The device cannot be written to  | ||
| + | |-  | ||
| + | | <code>ERROR_READ_FAULT = 30;</code>     | ||
| + | | The device cannot be read from  | ||
| + | |-  | ||
| + | | <code>ERROR_GEN_FAILURE = 31;</code>     | ||
| + | | The device has failed  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_SUPPORTED = 50;</code>     | ||
| + | | The request is not supported  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_DEV_NOT_EXIST = 55;</code>     | ||
| + | | The device does not exist  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_BAD_DEV_TYPE = 66;</code>     | ||
| + | | Invalid device type  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_ALREADY_ASSIGNED = 85;</code>     | ||
| + | | The device name is already in use  | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_PASSWORD = 86;</code>     | ||
| + | | Invalid pasword  | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_PARAMETER = 87;</code>     | ||
| + | | Invalid parameter  | ||
| + | |-  | ||
| + | |    | ||
| + | |-    | ||
| + | | <code>ERROR_SEM_IS_SET = 102;</code>    | ||
| + | | The semaphore is in use and cannot be closed  | ||
| + | |-  | ||
| + | | <code>ERROR_OPEN_FAILED = 110;</code>    | ||
| + | | The file or device could not be opened  | ||
| + | |-  | ||
| + | | <code>ERROR_CALL_NOT_IMPLEMENTED = 120;</code>   | ||
| + | | The function is not currently implemented  | ||
| + | |-  | ||
| + | | <code>ERROR_INSUFFICIENT_BUFFER = 122;</code>    | ||
| + | | The buffer passed is too small for the requested data  | ||
| + | |-  | ||
| + | | <code>ERROR_WAIT_NO_CHILDREN = 128;</code>    | ||
| + | | There are no child processes to wait for  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_LOCKED = 158;</code>    | ||
| + | | The entry is not locked  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_LOCK_FAILED = 167;</code>    | ||
| + | | The lock operation failed  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_ALREADY_EXISTS = 183;</code>    | ||
| + | | The file or object already exists  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_ENVVAR_NOT_FOUND = 203;</code>    | ||
| + | | The environment variable could not be found  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_LOCKED = 212;</code>    | ||
| + | | The entry is already locked  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_MORE_DATA = 234;</code>    | ||
| + | | More data is available than the provided buffer  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_WAIT_TIMEOUT = 258;</code>    | ||
| + | | The operation timed out  | ||
| + | |-  | ||
| + | | <code>ERROR_NO_MORE_ITEMS = 259;</code>    | ||
| + | | No more items available  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_NOT_OWNER = 288;</code>    | ||
| + | | The current thread is not the owner  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_OPERATION_ABORTED = DWORD(995);</code>   | ||
| + | | The I/O operation has been aborted because of either a thread exit or an application request  | ||
| + | |-  | ||
| + | | <code>ERROR_IO_INCOMPLETE = DWORD(996);</code>   | ||
| + | | Overlapped I/O event is not in a signaled state  | ||
| + | |-  | ||
| + | | <code>ERROR_IO_PENDING = DWORD(997);</code>   | ||
| + | | Overlapped I/O operation is in progress  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_CAN_NOT_COMPLETE = 1003;</code>   | ||
| + | | Cannot complete the function  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_NOT_FOUND = 1168;</code>   | ||
| + | | The entry or device was not found  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_INVALID_ACL = DWORD(1336);</code>    | ||
| + | | The access control list (ACL) structure is invalid  | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_SID = DWORD(1337);</code>    | ||
| + | | The security ID structure is invalid  | ||
| + | |-  | ||
| + | | <code>ERROR_INVALID_SECURITY_DESCR = DWORD(1338);</code>    | ||
| + | | The security descriptor structure is invalid  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_TIMEOUT = 1460;</code>   | ||
| + | | The operation returned because the timeout expired  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_FUNCTION_FAILED = 1627;</code>   | ||
| + | | The function call failed  | ||
| + | |-  | ||
| + | |    | ||
| + | |-   | ||
| + | | ''Errors below here have no compatibility equivalent''  | ||
| + | |    | ||
| + | |-   | ||
| + | | <code>ERROR_NOT_VALID = 1000001;</code>      | ||
| + | | The entry or device is not valid  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_ASSIGNED = 1000002;</code>      | ||
| + | | The device is not assigned  | ||
| + | |-  | ||
| + | | <code>ERROR_IN_USE = 1000003;</code>      | ||
| + | | The device is in use  | ||
| + | |-  | ||
| + | | <code>ERROR_OPERATION_FAILED = 1000004;</code>      | ||
| + | | The operation failed  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_OPEN = 1000005;</code>      | ||
| + | | The file or device is not open  | ||
| + | |-  | ||
| + | | <code>ERROR_ALREADY_OPEN = 1000006;</code>      | ||
| + | | The file or device is already open  | ||
| + | |-  | ||
| + | | <code>ERROR_WAIT_ABANDONED = 1000007;</code>      | ||
| + | | The operation was abandoned  | ||
| + | |-  | ||
| + | | <code>ERROR_IN_PROGRESS = 1000008;</code>      | ||
| + | | An operation is already in progress  | ||
| + | |-  | ||
| + | | <code>ERROR_RUNTIME_ERROR = 1000009;</code>      | ||
| + | | A run time occurred  | ||
| + | |-  | ||
| + | | <code>ERROR_EXCEPTION = 1000010;</code>      | ||
| + | | An exception occurred  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_PROCESSED = 1000011;</code>      | ||
| + | | The entry has not been processed  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_COMPLETED = 1000012;</code>      | ||
| + | | The entry or operation has not completed  | ||
| + | |-  | ||
| + | | <code>ERROR_NOT_COMPATIBLE = 1000013;</code>      | ||
| + | | The entry is not compatible for the operation  | ||
| + | |-  | ||
| + | | <code>ERROR_CANCELLED = 1000014;</code>      | ||
| + | | The entry or operation has been cancelled  | ||
| + | |-  | ||
| + | |    | ||
| + | |-  | ||
| + | | <code>ERROR_UNKNOWN = $FFFFFFFF;</code>  | ||
| + | |    | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
''To be documented''  | ''To be documented''  | ||
Revision as of 07:34, 22 September 2016
Return to Unit Reference
Description
To be documented
Constants
Universal error constants 
 ERROR_*  ERROR_SUCCESS = 0;
 | 
Success | 
 NO_ERROR = 0;
 | 
Success | 
 ERROR_INVALID_FUNCTION = 1;
 | 
Invalid function | 
 ERROR_FILE_NOT_FOUND = 2;
 | 
The file cannot be found | 
 ERROR_PATH_NOT_FOUND = 3;
 | 
The path cannot be found | 
 ERROR_TOO_MANY_OPEN_FILES = 4;
 | 
Too many open files | 
 ERROR_ACCESS_DENIED = 5;
 | 
Access is denied | 
 ERROR_INVALID_HANDLE = 6;
 | 
Invalid handle} | 
 ERROR_NOT_ENOUGH_MEMORY = DWORD(8);
 | 
Not enough storage is available to process this command | 
 ERROR_INVALID_ACCESS = 12;
 | 
Invalid access | 
 ERROR_INVALID_DATA = 13;
 | 
The data is invalid | 
 ERROR_OUTOFMEMORY = 14;
 | 
Not enough memory is available | 
 ERROR_INVALID_DRIVE = 15;
 | 
Cannot find the drive specified | 
 ERROR_CURRENT_DIRECTORY = 16;
 | 
Current directory cannot be removed | 
 ERROR_NOT_SAME_DEVICE = 17;
 | 
Cannot move the file to a different disk drive | 
 ERROR_NO_MORE_FILES = 18;
 | 
There are no more files | 
 ERROR_WRITE_PROTECT = 19;
 | 
Media is write protected | 
 ERROR_BAD_UNIT = 20;
 | 
Cannot find the device specified | 
 ERROR_NOT_READY = 21;
 | 
The device is not ready | 
 ERROR_BAD_COMMAND = 22;
 | 
The device does not recognise the command | 
 ERROR_WRITE_FAULT = 29;
 | 
The device cannot be written to | 
 ERROR_READ_FAULT = 30;
 | 
The device cannot be read from | 
 ERROR_GEN_FAILURE = 31;
 | 
The device has failed | 
 ERROR_NOT_SUPPORTED = 50;
 | 
The request is not supported | 
 ERROR_DEV_NOT_EXIST = 55;
 | 
The device does not exist | 
 ERROR_BAD_DEV_TYPE = 66;
 | 
Invalid device type | 
 ERROR_ALREADY_ASSIGNED = 85;
 | 
The device name is already in use | 
 ERROR_INVALID_PASSWORD = 86;
 | 
Invalid pasword | 
 ERROR_INVALID_PARAMETER = 87;
 | 
Invalid parameter | 
 ERROR_SEM_IS_SET = 102;
 | 
The semaphore is in use and cannot be closed | 
 ERROR_OPEN_FAILED = 110;
 | 
The file or device could not be opened | 
 ERROR_CALL_NOT_IMPLEMENTED = 120;
 | 
The function is not currently implemented | 
 ERROR_INSUFFICIENT_BUFFER = 122;
 | 
The buffer passed is too small for the requested data | 
 ERROR_WAIT_NO_CHILDREN = 128;
 | 
There are no child processes to wait for | 
 ERROR_NOT_LOCKED = 158;
 | 
The entry is not locked | 
 ERROR_LOCK_FAILED = 167;
 | 
The lock operation failed | 
 ERROR_ALREADY_EXISTS = 183;
 | 
The file or object already exists | 
 ERROR_ENVVAR_NOT_FOUND = 203;
 | 
The environment variable could not be found | 
 ERROR_LOCKED = 212;
 | 
The entry is already locked | 
 ERROR_MORE_DATA = 234;
 | 
More data is available than the provided buffer | 
 ERROR_WAIT_TIMEOUT = 258;
 | 
The operation timed out | 
 ERROR_NO_MORE_ITEMS = 259;
 | 
No more items available | 
 ERROR_NOT_OWNER = 288;
 | 
The current thread is not the owner | 
 ERROR_OPERATION_ABORTED = DWORD(995);
 | 
The I/O operation has been aborted because of either a thread exit or an application request | 
 ERROR_IO_INCOMPLETE = DWORD(996);
 | 
Overlapped I/O event is not in a signaled state | 
 ERROR_IO_PENDING = DWORD(997);
 | 
Overlapped I/O operation is in progress | 
 ERROR_CAN_NOT_COMPLETE = 1003;
 | 
Cannot complete the function | 
 ERROR_NOT_FOUND = 1168;
 | 
The entry or device was not found | 
 ERROR_INVALID_ACL = DWORD(1336);
 | 
The access control list (ACL) structure is invalid | 
 ERROR_INVALID_SID = DWORD(1337);
 | 
The security ID structure is invalid | 
 ERROR_INVALID_SECURITY_DESCR = DWORD(1338);
 | 
The security descriptor structure is invalid | 
 ERROR_TIMEOUT = 1460;
 | 
The operation returned because the timeout expired | 
 ERROR_FUNCTION_FAILED = 1627;
 | 
The function call failed | 
| Errors below here have no compatibility equivalent | |
 ERROR_NOT_VALID = 1000001;
 | 
The entry or device is not valid | 
 ERROR_NOT_ASSIGNED = 1000002;
 | 
The device is not assigned | 
 ERROR_IN_USE = 1000003;
 | 
The device is in use | 
 ERROR_OPERATION_FAILED = 1000004;
 | 
The operation failed | 
 ERROR_NOT_OPEN = 1000005;
 | 
The file or device is not open | 
 ERROR_ALREADY_OPEN = 1000006;
 | 
The file or device is already open | 
 ERROR_WAIT_ABANDONED = 1000007;
 | 
The operation was abandoned | 
 ERROR_IN_PROGRESS = 1000008;
 | 
An operation is already in progress | 
 ERROR_RUNTIME_ERROR = 1000009;
 | 
A run time occurred | 
 ERROR_EXCEPTION = 1000010;
 | 
An exception occurred | 
 ERROR_NOT_PROCESSED = 1000011;
 | 
The entry has not been processed | 
 ERROR_NOT_COMPLETED = 1000012;
 | 
The entry or operation has not completed | 
 ERROR_NOT_COMPATIBLE = 1000013;
 | 
The entry is not compatible for the operation | 
 ERROR_CANCELLED = 1000014;
 | 
The entry or operation has been cancelled | 
 ERROR_UNKNOWN = $FFFFFFFF;
 | 
To be documented
Type definitions
None defined
Public variables
None defined
Function declarations
None defined
Return to Unit Reference