Error Codes

All of the library’s API functions return error codes as their return values. These error codes (which are simply integer numbers) can be translated into human readable error strings by using the appropriate library API function. The error codes are enumerated in IMRSDK.h. IMRerrors.cpp has an example of a set of error strings.

Code

Value or Description

IMR_RES_OK

The requested operation was successfully executed.

IMR_RES_ERROR

Some unspecified error has occurred while executing the operation.

IMR_RES_INVALID_PARAMETER

An invalid parameter was specified to the function.

IMR_RES_NOT_INITIALIZED

The Redirection Library was not yet initialized.

IMR_RES_ALREADY_INITIALIZED

The Redirection Library has already been initialized.

IMR_RES_MEMALLOC_FAILED

Memory allocation has failed; not enough memory.

IMR_RES_UNSUPPORTED

The requested operation is unsupported by the library.

IMR_RES_CLIENT_NOT_FOUND

The specified client ID does not exist in the library’s list.

IMR_RES_DUPLICATE_CLIENT

A client with the specified properties (e.g., IP address) already exists in the library’s list.

IMR_RES_CLIENT_NOT_ACTIVE

The specified client has not been initialized by the library, although it exists in its list. This indicates an internal error in the library.

IMR_RES_CLIENT_ACTIVE

The specified client has already been initialized by the library. This indicates an internal error in the library.

IMR_RES_SESSION_ALREADY_OPEN

A session of the requested type (either SOL or Storage Redirection) is already opened with the specified client.

IMR_RES_SESSION_CLOSED

There is no open session of the requested type (either SOL or Storage Redirection) with the specified client.

IMR_RES_SOCKET_ERROR

A socket error has occurred.

IMR_RES_UNKNOWN_PROTOCOL

An internal error has occurred in the protocol handlers in the library.

IMR_RES_PROTOCOL_ALREADY_REGISTERED

An internal error has occurred in the protocol handlers in the library.

IMR_RES_PENDING

An internal error has occurred while trying to send a packet.

IMR_RES_UNEXPECTED_PACKET

An unexpected protocol packet has been received.

IMR_RES_TIMEOUT

A timeout has occurred while trying to execute the operation.

IMR_RES_CORRUPT_PACKET

A corrupted or malformed protocol packet has been received.

IMR_RES_OS_ERROR

An operating system error has occurred.

IMR_RES_IDER_VERSION_NOT_SUPPORTED

The client uses a Storage Redirection protocol of a version incompatible with the library’s version.

IMR_RES_IDER_COMMAND_RUNNING

An IDE-R command is in progress.

IMR_RES_STORAGE_FAILURE

An error occurred while trying to store client information.

IMR_RES_UNKNOWN

An unknown library result code was specified.

IMR_RES_AUTH_FAILED

Authentication with the client has failed.

IMR_RES_CLIENT_TYPE_UNKNOWN

The Storage Redirection session cannot be established for unknown reasons (Intel AMT sent an “unknown” status)

IMR_RES_CLIENT_BUSY

The client already has an open session of the relevant function (either SOL or Storage Redirection) with some other application.

IMR_RES_CLIENT_UNSUPPORTED

The library attempted to connect to a host capability that does not support Storage Redirection.

IMR_RES_CLIENT_ERROR

General error returned when trying to establish a Storage Redirection session.

IMR_RES_NOT_ENOUGH_SPACE

The function was provided with a buffer with insufficient space to successfully complete the operation.

IMR_RES_SESSION_LOOPBACK

The requested operation cannot be executed because the SOL session is in loopback mode.

IMR_RES_TLS_CONNECTION_FAILED

The library has failed to establish a TLS connection with the client. There might be a problem verifying the client’s certificate.

IMR_RES_SOCKS_ERROR

SOCKSv5 proxy returned an error.

IMR_RES_SOCKS_AUTH_FAIL

Library failed to connect due to authentication error.

IMR_RES_OOB_SOL_DISABLED

Local enable required before function will succeed.

IMR_RES_AUDIT_LOG_FULL

Audit log is either full or locked.

IMR_RES_CLIENT_INVALID_OPTION

Invalid parameter in function call.

IMR_RES_USER_CONSENT_REQUIRED

Command cannot complete until user consent sequence completes.

Copyright © 2006-2022, Intel Corporation. All rights reserved.