Return Codes

The following documents the possible return codes from method calls when using the OESIS Framework.

Return code macros

All success error codes are greater than or equal to 0 and all failure error codes are less than 0. There are 3 macros available for checking success or failure error codes.

To check an error code for success

#define WAAPI_SUCCESS(code) (((wa_int)(code))>=0)

The following examples illustrate how to use this macro function:

if( WAAPI_SUCCESS( WAAPI_OK ) ) 
{
  // Will enter the if-statement
}
if( WAAPI_SUCCESS( WAAPI_ERROR_GENERAL ) )
{
  // Will NOT enter the if-statement
}

To check an error code for failure

#define WAAPI_FAILED(code) (((wa_int)(code))<0)

The following examples illustrate how to use this macro function:

if( WAAPI_FAILED( WAAPI_ERROR_GENERAL ) ) 
{
  // Will enter the if-statement
}
if( WAAPI_FAILED( WAAPI_OK ) )
{
  // Will NOT enter the if-statement
}

To check an error code for special success case. These codes are considered successful, but provide additional information about the current product state. When a special success code is returned, some of the data returned from the call be be unavailable.

#define WAAPI_SUCCESS_SPECIAL(code) (((wa_int)(code))>=1000)

The following examples illustrate how to use this macro function:

if( WAAPI_SUCCESS_SPECIAL( WAAPI_OK_NO_SCAN_REPORTED ) ) 
{
  // Will enter the if-statement
}
if( WAAPI_SUCCESS_SPECIAL( WAAPI_OK ) )
{
  // Will NOT enter the if-statement
}

Success codes

Every function call will return one of the following codes to determine the success or failure of the call.

Defines a success.

#define WAAPI_OK 0

Defines a success and value of TRUE.

#define WAAPI_OK_TRUE 1

Defines a success and value of FALSE.

#define WAAPI_OK_FALSE 2

Defines a partial success (for multiple operations, some succeeded and some failed).

#define WAAPI_PARTIAL_SUCCESS 3

Defines a successful call, but requested resource wasn't found in local cache and must be pulled from network.

#define WAAPI_OPERATION_INPROGRESS 4

Defines a successful call, but the data being used in the call is considered old by the api.

#define WAAPI_CACHE_DATA_STALE 5

Defines a successful call where not all results have been retreived. This may be returned from an asynchronous call where additional results are still being generated.

#define WAAPI_OK_MORE_RESULTS 6

Defines a successful call where not all desired effects have been achieved. This may be returned when a reference has been released but the operation did not complete due to still-positive reference count.

#define WAAPI_OK_IN_USE 7

Defines a successful call where the database (libwaresource) version is older than core version (libwaapi).

#define WAAPI_OK_OUTDATED_DATABASE 8

For method GetActiveUserInfo only. Defines a successful call where a failure occurred when trying to get the password protection state but username and domain are successfully retrieved. 'protected' field will be set to false (default value), but should not be taken into consideration.

#define WAAPI_FAILED_TO_GET_PASSWORD_PROTECTION 9

Defines a successful call where the device is required to reboot for the functionality to be operational.

#define WAAPI_OK_RESTART_TO_ENABLE 10

Defines a successful call, but no connected keyboards were detected for the Anti Keylogger feature.

#define WAAPI_OK_NO_KEYBOARD_DETECTED 11

Defines a successful call, but the request is not completed because user request to cancel.

#define WAAPI_OK_CANCELED 12

Indicates a successful call, but the request was not completed because control of the helper process was lost. The helper reported this result before becoming unresponsive.

#define WAAPI_OK_RESULT_BEFORE_LOST_CONTROL 13

Defines a success but validation failed

#define WAAPI_OK_VALIDATION_FAILED 14

Defines a success but cannot perform validation

#define WAAPI_OK_CANNOT_VALIDATE 15

Define a success, but validation is not supported for the product

#define WAAPI_OK_VALIDATION_NOT_SUPPORTED 16

Define a success, but requires removing all Apple devices to complete the process

#define WAAPI_OK_PENDING_REMOVE_APPLE_DEVICES 17

Indicates successful initialization, but the current engine version is outdated and cannot fully process data from the newer database. Updating the engine is recommended for full compatibility.

#define WAAPI_OK_OUTDATED_ENGINE 18

For method GetActiveUserInfo only. Defines a successful call where a failure occurred when trying to get the User Principal Name but username and domain are successfully retrieved.

#define WAAPI_FAILED_TO_GET_USER_PRINCIPAL_NAME 19

For method GetActiveUserInfo only. Defines a successful call where the User Principal Name is not available, and the username, domain are successfully retrieved.

#define WAAPI_OK_USER_PRINCIPAL_NAME_NOT_AVAILABLE 20

HTTP ok success code.

#define HTTP_OK 200

HTTP created success code.

#define HTTP_CREATED 201

HTTP non authoritative success code.

#define HTTP_NON_AUTHORITATIVE 203

HTTP no content success code.

#define HTTP_NO_CONTENT 204

HTTP reset content success code.

#define HTTP_RESET_CONTENT 205

HTTP partial content success code.

#define HTTP_PARTIAL_CONTENT 206

Defines data is live.

#define VMOD_DATA_LIVE 1000

Defines data is cached.

#define VMOD_DATA_CACHED 1001

Defines data is expired.

#define VMOD_DATA_EXPIRED 1002

Defines product installation requires OS restart.

#define WA_VMOD_INSTALLATION_NEED_RESTART 1003

Defines product installation requires OS restart after sucessfully install partially.

#define WA_VMOD_PARTIAL_INSTALLATION_NEED_RESTART 1004

Defines that product installation requires an application restart.

#define WA_VMOD_INSTALLATION_NEED_APPLICATION_RESTART 1005

Returned by GetLatestInstaller / InstallFromFiles when instance_id routing redirected the call to the system package manager flow (APT / DNF / SNAP / ...). The operation completed successfully via the system flow.

#define WA_VMOD_REDIRECTED_TO_SYSTEM_FLOW 1006

Defines a success when package is already installed.

#define WA_VMOD_INSTALLATION_ALREADY_INSTALLED 1007

Defines a successful call, but that a product has never, or does not report that it has ever, run a Backup.

#define WAAPI_OK_NO_BACKUP_REPORTED 2000

Defines a successful call, but that a product's user interface may not reflect any changes.

#define WAAPI_OK_NOT_SHOWN_IN_GUI 5000

Defines a successful call, but that a product has never, or does not report that it has ever, run a scan.

#define WAAPI_OK_NO_SCAN_REPORTED 5001

Defines a successful call, but the product cannot perform the operation because of an expired license.

#define WAAPI_OK_PRODUCT_LICENSE_EXPIRED 5002

Defines a successful call, but the product may not be able to perform the operation without some interaction from the user in the product UI.

#define WAAPI_OK_USER_INTERACTION 5003

Defines a successful call, but the product may open a user interface in order to perform the operation.

#define WAAPI_OK_GUI_DISPLAYED 5004

Defines a successful call, file contents was copied but NTFS name streams couldn't be copied.

#define WAAPI_OK_ALTERNATE_STREAMS_NOT_COPIED 5005

Defines a successful call for circumstance the user does not set yet.

#define WAAPI_OK_USER_DOES_NOT_SET 5006

Error codes

Defines a general failure condition that is used when no more specific error type applies.

#define WAAPI_ERROR_GENERAL -1

Defines an error when the license file is missing.

#define WAAPI_ERROR_LICENSE_MISSING -2

Defines an error when the license provided does not match the license file.

#define WAAPI_ERROR_LICENSE_MISMATCH -3

Defines an error when the license key has expired, not be to be confused with component licenses.

#define WAAPI_ERROR_LICENSE_EXPIRED -4

Defines an error when the API has not been initialized, yet a call requiring initialization was invoked.

#define WAAPI_ERROR_NOT_INITIALIZED -5

Defines an error when initialization is called when the API is already initialized.

#define WAAPI_ERROR_ALREADY_INITIALIZED -6

Defines an error when a call is made to a component that is not licensed.

#define WAAPI_ERROR_COMPONENT_NOT_LICENSED -7

Defines an error when a call is made to a component whose license has expired.

#define WAAPI_ERROR_COMPONENT_LICENSE_EXPIRED -8

Defines an error when a call is made to a component that is licensed, but is not deployed.

#define WAAPI_ERROR_COMPONENT_NOT_DEPLOYED -9

Defines an error when the component module from disk has been tampered with, therefore unloaded by the api.

#define WAAPI_ERROR_COMPONENT_TAMPERED -10

Defines an error when a method call was made on a component that does not support it.

#define WAAPI_ERROR_COMPONENT_METHOD_NOT_SUPPORTED -11

Defines an error when a method call was made on a component that does not implement it.

#define WAAPI_ERROR_COMPONENT_METHOD_NOT_IMPLEMENTED -12

Defines an error when the database is missing.

#define WAAPI_ERROR_DATABASE_MISSING -13

Defines an error when the database exists but is corrupted.

#define WAAPI_ERROR_DATABASE_CORRUPTED -14

Defines an error when a lookup in the database is missing. Perhaps the database is out of date?

#define WAAPI_ERROR_DATABASE_ENTRY_MISSING -15

Defines an error when the database is queried when it has yet to be initialized.

#define WAAPI_ERROR_DATABASE_NOT_INITIALIZED -16

Defines an error where an expected connection is unavailable, either between internal SDK components or to an external network (such as the Internet, or between Server and Agent, etc.).

#define WAAPI_ERROR_NO_CONNECTION -17

Defines an error when the provided computer name or IP to a remote call is not found in the network.

#define WAAPI_ERROR_IP_NOT_FOUND -18

Defines an error when authentication is required but fails due to missing or invalid credential information (user, password, domain, etc.).

#define WAAPI_ERROR_INVALID_CREDENTIALS -19

Defines an error when one or more input parameters are missing or violate the method's documented input constraints.

#define WAAPI_ERROR_INVALID_INPUT_ARGS -20

Defines an error when the provided JSON is not properly formatted or cannot be parsed.

#define WAAPI_ERROR_INVALID_JSON -21

Defines a failure condition due to insufficient permissions (for example, admin privileges) to access one or more of the required resources.

#define WAAPI_ERROR_ACCESS_DENIED -22

Defines an error when the system or product is in an invalid state to perform the invocation call requested.

#define WAAPI_ERROR_INVALID_STATE -23

Defines an error when a product is required to be running in order to perform the invocation call requested, yet the product is no longer running.

#define WAAPI_ERROR_NOT_RUNNING -24

Defines an error when working with Component Object Model (COM) on the Windows platform.

#define WAAPI_ERROR_COM -25

Defines an error when a request is dispatched and an exception is thrown.

#define WAAPI_ERROR_DISPATCH_EXCEPTION -26

Defines an error in a native system API.

#define WAAPI_ERROR_NATIVE_API -27

Defines an error when an object is not found. This can be objects held internally, or objects on the endpoint, such as files, backup times, etc.

#define WAAPI_ERROR_NOT_FOUND -28

Defines an error when an object is not found in the Windows Registry. Windows only.

#define WAAPI_ERROR_REGISTRY_NOT_FOUND -29

Defines an error when an operating is made to the Windows Registry and the operation is denied access. Windows only.

#define WAAPI_ERROR_REGISTRY_ACCESS_DENIED -30

Defines an error when a query operating is made to the Windows Registry and the data type read is not currently supported by the API. Windows only.

#define WAAPI_ERROR_REGISTRY_READ_TYPE_NOT_SUPPORTED -31

Defines an error that occurs in the Windows Registry but cannot be specified by a more specific registry error code. Windows only.

#define WAAPI_ERROR_REGISTRY_GENERAL -32

Defines an error that occurs with our encryption/decryption security module.

#define WAAPI_ERROR_CRYPTO -33

Defines an error when a cache entry is missing.

#define WAAPI_ERROR_NO_CACHE_ENTRY -34

Defines an error when a cache entry exists, but it is out of date.

#define WAAPI_ERROR_CACHE_OUT_OF_DATE -35

Defines an error when the configuration value for a valid key is of the incorrect type.

#define WAAPI_ERROR_INVALID_CONFIG_VALUE -36

Defines an error when the configuration key is not a valid configuration option.

#define WAAPI_ERROR_INVALID_CONFIG_KEY -37

Defines an error when an expression is in an invalid format.

#define WAAPI_ERROR_INVALID_SYNTAX -38

Defines an error when a dynamic function call is invalid.

#define WAAPI_ERROR_NOT_A_FUNCTION -39

Defines a timeout for uninstallation.

#define WAAPI_ERROR_UNINSTALL_TIMEOUT -40

Defines an error internal to the scripting engine.

#define WAAPI_ERROR_SCRIPTING_ENGINE -41

Defines a general error within a script.

#define WAAPI_ERROR_SCRIPTING_GENERAL -42

Defines a general error during a WMI call.

#define WAAPI_ERROR_WMI -43

Defines an error that occurs when an attempt to compile a script.

#define WAAPI_ERROR_SCRIPT_COMPILE_FAILURE -44

Defines an error when an expression is found to be invalid or corrupt.

#define WAAPI_ERROR_MALFORMED_EXPRESSION -45

Defines an error in the local caching mechanism.

#define WAAPI_ERROR_LOCAL_CACHE -46

Defines an error when a digital signature failed checksum verification.

#define WAAPI_ERROR_INVALID_SIGNATURE -47

Defines an error when a hash value does not match the expected value.

#define WAAPI_ERROR_HASH_MISMATCH -48

Defines an error when an internal thread failed to respond in a timely manner.

#define WAAPI_ERROR_THREAD_TIMEOUT -49

Defines an error when no active user session is found.

#define WAAPI_ERROR_NO_ACTIVE_USER_SESSION -50

Defines an error when the mockup json is not properly formatted or missing required information. Only returned when using WAAPI_CONFIG_MOCKUP_MODE setup config option.

#define WAAPI_ERROR_INVALID_MOCKUP -51

Defines an error when there are too many sub-queries in a bulk query.

#define WAAPI_ERROR_TOO_MANY_QUERIES -52

Defines an error when a Bundle resource cannot be found. Mac only.

#define WAAPI_ERROR_BUNDLE_NOT_FOUND -53

Defines an error when the API does not have necessary permissions to access a necessary bundle resource. Mac only.

#define WAAPI_ERROR_BUNDLE_ACCESS_DENIED -54

Defines an error when an operation on a bundle resource fails. Mac only.

#define WAAPI_ERROR_BUNDLE_GENERAL -55

Defines an error where the requested call or operation is currently running and concurrent operations are not supported.

#define WAAPI_ERROR_OPERATION_IN_PROGRESS -56

Defines an error when an operation did not complete because a resource is being used.

#define WAAPI_ERROR_IN_USE -57

Defines an error when the output arguments provided do not match the methods documented output requirements. Not to be confused with WAAPI_ERROR_INVALID_JSON

#define WAAPI_ERROR_INVALID_OUTPUT_ARGS -58

Defines an error when the license provided is not valid for requested mode of operation.

#define WAAPI_ERROR_LICENSE_INVALID -59

Defines an error when a connection to wa_3rd_party_host_32.exe/wa_3rd_party_host_64.exe cannot be established.

#define WAAPI_ERROR_3RD_PARTY_HOST_CONNECTION_NOT_ESTABLISHED -60

This is not an actual error. Will print additional information for the main error. Will not be retuned from an API call but will be available in the method output in case of an error.

#define WAAPI_ERROR_INFORMATION -61

Defines an error when the access is denied for the invocation call requested, due to tamper protection of the AV product being active.

#define WAAPI_ERROR_TAMPER_PROTECTION_ON -62

Defines an error when an invalid value is provided for 'instance_id' key, when a signature has multiple instances installed on the same machine.

#define WAAPI_ERROR_INVALID_INSTANCE_ID -63

Defines an error when the operation fails because it can not bypass password protection.

#define WAAPI_ERROR_PASSWORD_REQUIRED -64

Defines an error when the operation fails because it can not bypass captcha protection.

#define WAAPI_ERROR_CAPTCHA_REQUIRED -65

Defines an error when an invoke call is attempted while a teardown request is already in progress.

#define WAAPI_ERROR_TEARDOWN_BUSY -66

Defines an error when the component location configuration is invalid.

#define WAAPI_ERROR_INVALID_CONFIG_COMPONENT_LOCATION -67

Defines an error when real-time monitoring is not implemented yet for a method.

#define WAAPI_ERROR_REAL_TIME_MONITORING_METHOD_NOT_IMPLEMENTED -68

Defines an error when memory has been corrupted. Please restart the process to recover the SDK.

#define WAAPI_ERROR_MEMORY_CORUPTED -69

Defines an error when the requested resource, either managed by SDK or external, is busy and temporarily unavailable. The operation may succeed once the resource becomes available.

#define WAAPI_ERROR_RESOURCE_BUSY -70

Defines an error when unable to initialize the bundle restriction search.

#define WAAPI_ERROR_FAILED_TO_INIT_BUNDLE_RESTRICTION_SEARCH -71

Defines an error when the operation is blocked due to a security application warning.

#define WAAPI_ERROR_OPERATION_BLOCKED_BY_SECURITY_APP -72

Defines an error where the operation can't be completed because package sources are missing.

#define WAAPI_ERROR_MISSING_PACKAGE_SOURCES -73

Defines an error when unable to query the package information.

#define WAAPI_ERROR_MISSING_PACKAGE_INFORMATION -74

Defines an error when no data is currently available.

#define WAAPI_ERROR_NO_DATA -75

Defines an error when a specific resource is not available. This can be a file, a network connection, or any other resource that the API requires to function properly.

#define WAAPI_ERROR_RESOURCE_NOT_AVAILABLE -76

Defines an error where the operation can't be completed because package sources are out of date.

#define WAAPI_ERROR_PACKAGE_SOURCES_OUT_OF_DATE -77

Defines an error when the file is marked with the Mark of the Web (MOTW).

#define WAAPI_ERROR_FILE_MARKED_MOTW -78

Defines an error when the operation fails due to a file or process running at a low or untrusted integrity level.

#define WAAPI_ERROR_LOW_INTEGRITY_LEVEL -79

Defines an error when preprocessing the installer fails.

#define WAAPI_ERROR_FAILED_TO_PREPROCESS_INSTALLER -80

Defines an error when the dependency cannot be installed, or the dependency is installed but does not match the required version.

#define WAAPI_ERROR_MISSING_PACKAGE_DEPENDENCIES -81

Defines an error when your package has been temporarily paused due to a specific reason.

#define WAAPI_ERROR_PACKAGE_ON_HOLD -82

Defines an error when an operation stops because an indirection path is detected.

#define WAAPI_ERROR_INDIRECTION_PATH_DETECTED -83

Defines an error when the SDK fails to obtain a non-elevated token.

#define WAAPI_ERROR_FAILED_TO_OBTAIN_NON_ELEVATED_TOKEN -84

Defines an error where the operation can't be completed because package sources are invalid.

#define WAAPI_ERROR_INVALID_PACKAGE_SOURCES -85

Defines an error where the operation can't be completed because the system is out of memory.

#define WAAPI_ERROR_OUT_OF_MEMORY -86

Defines an error when the patch title is not found. The patch title must exactly match the value returned by the GetMissingPatches method.

#define WAAPI_ERROR_PATCH_TITLE_NOT_FOUND -87

Defines an error that occurs when the SDK fails to install the service.

#define WAAPI_ERROR_INSTALL_SERVICE_FAILED -88

Defines an error that occurs when the SDK fails to uninstall the service.

#define WAAPI_ERROR_UNINSTALL_SERVICE_FAILED -89

Defines an error when the 'connectivity_check' configuration option is not an object.

#define WAAPI_ERROR_CONFIG_INVALID_CONNECTIVITY_CHECK_TYPE -90

Defines an error when the 'global_urls' configuration option is not an array.

#define WAAPI_ERROR_CONFIG_INVALID_GLOBAL_URLS_TYPE -91

Defines an error when the system failed to initiate or complete the restart.

#define WAAPI_ERROR_FAILED_TO_RESTART -92

Defines an error when a restart cannot proceed because it requires user interaction.

#define WAAPI_ERROR_FAILED_TO_RESTART_DUE_TO_USER_ACTION_REQUIRED -93

Defines an error when an SDK operation cannot proceed because the logged-out user's registry is corrupted.

#define WAAPI_ERROR_LOGGED_OUT_USER_REGISTRY_CORRUPTED -94

Defines an error when the Uninstall function attempts to uninstall a product whose version is outside the range validated by OPSWAT, and the operation fails.

#define WAAPI_ERROR_UNINSTALL_UNVALIDATED_VERSION -95

Defines an error when the SDK fails to get the product version.

#define WAAPI_ERROR_FAILED_TO_GET_PRODUCT_VERSION -96

Defines an error when a product is disabled on the system and cannot be started or used.

#define WAAPI_ERROR_PRODUCT_DISABLED -97

Defines an error when a product is inactive because it has been superseded by another product on the system.

#define WAAPI_ERROR_PRODUCT_SUPERSEDED_BY_ANOTHER_PRODUCT -98

Defines an error when a product service could not be started.

#define WAAPI_ERROR_FAILED_TO_START_SERVICE -99

Defines an error when the package manager (e.g., apt) is in a broken or interrupted state.

#define WAAPI_ERROR_BROKEN_PACKAGE_MANAGER -100

Defines an error when an exception occurs.

#define WAAPI_ERROR_EXCEPTION_OCCURRED -101

Defines an error when the license provided is invalid.

#define WAAPI_ERROR_INVALID_LICENSE -102

Defines an error when preflight checks fail.

#define WAAPI_ERROR_PREFLIGHT_CHECK_FAILED -103

Defines an error when a pipe squatting attempt is detected.

#define WAAPI_ERROR_PIPE_SQUATTING_DETECTED -104

Request returned an http 300 multiple choices notification.

#define HTTP_MULTIPLE_CHOICES -300

Request returned an http 301 moved permanently notification.

#define HTTP_MOVED_PERMANENTLY -301

Request returned an http 302 found notification.

#define HTTP_FOUND -302

Request returned an http 303 see other notification.

#define HTTP_SEE_OTHER -303

Request returned an http 304 not modified notification.

#define HTTP_NOT_MODIFIED -304

Request returned an http 305 use proxy notification.

#define HTTP_USE_PROXY -305

Request returned an http 307 temporary redirect notification.

#define HTTP_TEMPORARY_REDIRECT -307

Request returned an http 400 bad request error.

#define HTTP_BAD_REQUEST -400

Request returned an http 401 unauthorized error.

#define HTTP_UNAUTHORIZED -401

Request returned an http 403 forbidden error.

#define HTTP_FORBIDDEN -403

Request returned an http 404 not found error.

#define HTTP_NOT_FOUND -404

Request returned an http 405 method not allowed error.

#define HTTP_METHOD_NOT_ALLOWED -405

Request returned an http 406 not acceptable error.

#define HTTP_NOT_ACCEPTABLE -406

Request returned an http 407 proxy authentication required error.

#define HTTP_PROXY_AUTHENTICATION_REQUIRED -407

Request returned an http 408 request timeout error.

#define HTTP_REQUEST_TIMEOUT -408

Request returned an http 409 conflict.

#define HTTP_CONFLICT -409

Request returned an http 410 gone error.

#define HTTP_GONE -410

Request returned an http 411 length required error.

#define HTTP_LENGTH_REQUIRED -411

Request returned an http 412 precondition failed error.

#define HTTP_PRECONDITION_FAILED -412

Request returned an http 413 request entity too large error.

#define HTTP_REQUEST_ENTITY_TOO_LARGE -413

Request returned an http 414 request uri too long error.

#define HTTP_REQUEST_URI_TOO_LONG -414

Request returned an http 415 unsupported media type error.

#define HTTP_UNSUPPORTED_MEDIA_TYPE -415

Request returned an http 416 range not satisfiable error.

#define HTTP_REQUESTED_RANGE_NOT_SATISFIABLE -416

Request returned an http 417 expectation failed error.

#define HTTP_EXPECTATION_FAILED -417

Request returned an http 500 internal server error.

#define HTTP_INTERNAL_SERVER_ERROR -500

Request returned an http 501 not implemented error.

#define HTTP_NOT_IMPLEMENTED -501

Request returned an http 502 bad gateway error.

#define HTTP_BAD_GATEWAY -502

Request returned an http 503 service unavailable error.

#define HTTP_SERVICE_UNAVAILABLE -503

Request returned an http 504 gateway timeout error.

#define HTTP_GATEWAY_TIMEOUT -504

Request returned an http 505 version not supported error.

#define HTTP_VERSION_NOT_SUPPORTED -505

Request failed because the current version is too old. Please use a newer one.

#define HTTP_INVALID_VERSION_STAMP -506

Defines an error when the COM object is not available.

#define VMOD_ERROR_OESIS_COM_NOT_AVAILABLE -1000

Defines an error when the On Demand object is not available.

#define VMOD_ERROR_OOD_NOT_AVAILABLE -1001

Defines an error when there is problem initialize COM lib.

#define VMOD_ERROR_INITIALIZE_COM -1002

Defines an error that occurs during the activation of On-Demand mode.

#define VMOD_ERROR_ACTIVATE_OOD -1003

Defines an error when OOD object is not initialized.

#define VMOD_ERROR_OOD_NOT_INITIALIZED -1004

Defines an error when queried product can't be found.

#define VMOD_ERROR_PRODUCT_NOT_FOUND -1005

Defines an error when queried product interface isn't supported.

#define VMOD_ERROR_INTERFACE_NOT_SUPPORTED -1006

Defines an error when queried product cannot update.

#define VMOD_ERROR_CANNOT_UPDATE_PRODUCT -1007

Defines an error when queried product cannot locate cache.

#define VMOD_ERROR_CANNOT_FIND_CACHE_FILE -1008

Defines an error when queried call isn't cached.

#define VMOD_ERROR_QUERY_ISNT_CACHED -1009

Defines an error when caching isn't enabled.

#define VMOD_ERROR_CACHING_IS_DISABLED -1010

Defines an error when definition state cannot be retrieved.

#define VMOD_ERROR_CANNOT_GET_DEF_STATE -1011

Defines an error when GEARS cannot detect products.

#define VMOD_ERROR_CANNOT_DETECT_PRODUCTS -1012

Defines an error when GEARS cannot be initialized.

#define VMOD_ERROR_GEARS_CANNOT_INITIALIZE -1013

Defines an error when an operation did not complete because it requires a newer version of server.

#define VMOD_ERROR_LEGACY_SERVER -1014

Defines an error when an operation did not complete because server couldn't be reached.

#define VMOD_ERROR_NOROUTETOSERVER -1015

Defines an error when there is a mismatch in output format between internal components.

#define WA_VMOD_ERROR_INTERNAL_FORMAT_MISMATCH -1016

Defines an error when UpdateVerify is not initialized.

#define WA_VMOD_ERROR_UPDATEVERIFY_NOT_INITIALIZED -1017

Defines an error when not initialized.

#define WA_VMOD_ERROR_4V_NOT_INITIALIZED -1018

Defines an error when VMod Source is not initialized.

#define WA_VMOD_ERROR_OFFLINEVMOD_NOT_INITIALIZED -1019

Defines an error when unable to get product's version.

#define WA_VMOD_ERROR_CANNOT_GET_VERSION -1020

Defines an error when the procedure to retrieve system updates is timeout.

#define WA_VMOD_ERROR_GET_SYSTEM_PATCH_TIMEOUT -1021

Defines an error when unable to retrieve OS info.

#define WA_VMOD_ERROR_GEARS_CANNOT_GET_OS_INFO -1022

Defines an error when the vulnerability source in input is invalid.

#define WA_VMOD_ERROR_INVALID_VULN_SOURCE -1023

Defines an error when a product is not supported.

#define WA_VMOD_ERROR_PRODUCT_NOT_SUPPORTED -1026

Defines an error when a language is not supported.

#define WA_VMOD_ERROR_LANGUAGE_NOT_SUPPORTED -1027

Defines an error when an architecture is not supported.

#define WA_VMOD_ERROR_ARCHITECTURE_NOT_SUPPORTED -1028

Defines an error when the file type is not supported.

#define WA_VMOD_ERROR_NOT_RECOGNIZED_FILE -1029

Cannot close all blocking processes.

#define WA_VMOD_ERROR_CANNOT_TERMINATE_PRODUCT -1030

Cannot retrieve list of blocking processes.

#define WA_VMOD_ERROR_CANNOT_GET_PROCESSES -1031

Existing product needs to be uninstalled before installation.

#define WA_VMOD_ERROR_NEED_UNINSTALL_PRODUCT_FIRST -1033

Installation failed.

#define WA_VMOD_ERROR_INSTALLATION_FAILED -1034

File/installer extraction failed.

#define WA_VMOD_ERROR_EXTRACT_FAILED -1036

Defines that there isn't enough memory.

#define WA_VMOD_ERROR_OUT_OF_MEMORY -1037

Defines an error when the type of data/content is not supported.

#define WA_VMOD_ERROR_DATA_TYPE_NOT_SUPPORTED -1038

Defines an error when the queried index is out of array range.

#define WA_VMOD_ERROR_OUT_OF_RANGE -1039

Defines an error when the online database prefix is not set or invalid

#define WA_VMOD_ERROR_INVALID_ONLINE_DB_URI -1040

Defines an error when the operation fails because another MSI installation process is running.

#define WA_VMOD_ERROR_ANOTHER_MSI_INSTALLATION_INPROGRESS -1041

Defines an error when product version mismatches with expected version

#define WA_VMOD_ERROR_VERSION_MISMATCH -1042

Defines an error when unable to perform the requested verification.

#define WA_VMOD_ERROR_CANNOT_VERIFY -1043

Defines an error when detected circular package

#define WA_VMOD_ERROR_CIRCULAR_PACKAGE -1044

Defines an error when validate failed

#define WA_VMOD_ERROR_VALIDATE_FAILED -1045

Defines an error when an os architecture is not supported.

#define WA_VMOD_ERROR_OS_ARCHITECTURE_NOT_SUPPORTED -1046

Defines an error when the delay timeframe is not passed.

#define WA_VMOD_DELAY_TIMEFRAME_NOT_REACHED -1047

Defines an error when a request timeout related to WaHost is elapsed.

#define WAAPI_ERROR_HOST_REQUEST_TIMEOUT -1048

Defines an error when device is run out of memory.

#define WAAPI_ERROR_NO_FREE_SPACE -1049

Defines an error when uncompression failed.

#define WAAPI_ERROR_FAILED_TO_UNCOMPRESS -1050

Defines an error when system privilege is required.

#define WAAPI_ERROR_SYSTEM_PRIVILEGE_REQUIRED -1051

Defines an error when the SDK cannot verify the installer's version against the requested version.

#define WA_VMOD_VERSION_LOCK_NOT_SUPPORTED -1052

Defines an error when the specified file property name is not found.

#define WA_VMOD_ERROR_FILE_PROPERTY_NAME_NOT_FOUND -1053

Defines an error that indicates the method is not supported when executed under SYSTEM privilege in an RDP (Remote Desktop Protocol) session.

#define WAAPI_ERROR_RDP_UNSUPPORTED_UNDER_SYSTEM_PRIVILEGE -1054

Defines an error when multiple active Remote Desktop Protocol sessions are not supported.

#define WAAPI_ERROR_RDP_MULTI_SESSION_UNSUPPORTED -1055

Defines an error when the active Remote Desktop Protocol user does not match the process owner.

#define WAAPI_ERROR_RDP_USER_MISMATCH -1056

Defines an error when BitLocker is not enabled on the specified drive.

#define WAAPI_ERROR_BITLOCKER_NOT_ENABLED -1057

Defines an error when the Trusted Platform Module (TPM) is not available for BitLocker operations.

#define WAAPI_ERROR_BITLOCKER_TPM_NOT_AVAILABLE  -1058

Defines an error when the preparation steps for BitLocker encryption fail.

#define WAAPI_ERROR_BITLOCKER_PREPARATION_FAILED -1059

Defines an error when the BitLocker encryption process fails.

#define WAAPI_ERROR_BITLOCKER_ENCRYPTION_FAILED -1060

Defines an error when retrieving the BitLocker recovery key fails.

#define WAAPI_ERROR_GET_RECOVERY_KEY_FAILED -1061

Defines an error when no recovery password is configured for BitLocker.

#define WAAPI_ERROR_NO_RECOVERY_PASSWORD_CONFIGURED -1062

Defines an error when the required service is not yet ready.

#define WAAPI_ERROR_SERVICE_NOT_READY -1063

Defines an error when the installation process fails to complete. Possible reasons: (1) Installation canceled by the user. (2) Installation canceled because another installation is in progress. (3) Out of disk space during installation. (4) Unknown language ID.

#define WAAPI_VMOD_ERROR_COMPLETING_INSTALLATION_SCENARIO -1064

Defines an error when the installer cancels the installation because running applications block the update. Close the blocking applications, wait a few seconds for background processes to exit, and run the update again. Avoid using these applications during installation to prevent this error.

#define WAAPI_VMOD_ERROR_INSTALLATION_SCENARIO_CANCELED -1065

Defines an error when the device vendor is not supported.

#define WA_VMOD_ERROR_VENDOR_NOT_SUPPORTED -1066

Defines an error when the device model is not supported.

#define WA_VMOD_ERROR_MODEL_NOT_SUPPORTED -1067

Defines an error when installation dependencies are not satisfied.

#define WA_VMOD_ERROR_DEPENDENCIES_NOT_MET -1068

Defines an error when no matching signature is installed.

#define WA_VMOD_ERROR_NO_SIGNATURE_INSTALLED -1069

Defines an error when multiple matching signatures are installed (ambiguous).

#define WA_VMOD_ERROR_MULTIPLE_SIGNATURES_INSTALLED -1070

Defines an error when package is evaluated to be not installable.

#define WA_VMOD_ERROR_PACKAGE_NOT_INSTALLABLE -1071

Defines an error when there is not enough disk space to perform the operation.

#define WAAPI_ERROR_INSUFFICIENT_DISK_SPACE -1072

Defines an error when the system package manager failed to install the package, or the package was not in the expected installed state after the installation completed.

#define WAAPI_ERROR_FAILED_TO_INSTALL_PACKAGE -1073

Defines an error when the install request does not contain the required installer path input.

#define WAAPI_ERROR_MISSING_INSTALLER_PATH -1074

Defines an error when the installer path in the install request could not be read.

#define WAAPI_ERROR_INVALID_INSTALLER_PATH -1075

Defines an error when a package's information could not be retrieved - either from the installer file before installation, or from the system package manager after installation.

#define WAAPI_ERROR_CANNOT_GET_PACKAGE_INFORMATION -1076

Defines an error when the package name could not be extracted from the installer file. The file is not a valid package for the system's package manager (e.g., a Debian package) or is corrupted.

#define WAAPI_ERROR_INVALID_PACKAGE_FILE -1077

Defines an error when the installer file specified in the request does not exist on disk.

#define WAAPI_ERROR_INSTALLER_FILE_NOT_FOUND -1078

Defines an error when the package's dependency information could not be parsed.

#define WAAPI_ERROR_DEPENDENCY_PARSE_FAILED -1079

Defines an error when the requested regulatory compliance framework version is not supported.

#define WAAPI_ERROR_FRAMEWORK_VERSION_NOT_SUPPORTED -1080

Defines an error when enumerating local user accounts fails outright (a genuine system/API error), as distinct from finding zero accounts, which is not an error.

#define WAAPI_ERROR_USER_ENUMERATION_FAILED -1081

Defines an error when the installer file supplied to InstallFromFiles is not valid: missing, hash mismatch against expected_installer_sha256, or an invalid/missing code signature.

#define WAAPI_ERROR_INVALID_INSTALLER -1082

Return code macros​

Success codes​

Error codes​

Return code macros

Success codes

Error codes