HSDC_Sdk_Errors.h

For the source code for this file, see HSDC_Sdk_Errors.h source.

Enumerations

enum HSDCError {
HSDCErrorSuccess = 0, HSDCErrorNotImplemented = 0x80000001, HSDCErrorFailed, HSDCErrorInvalidArgHSDCErrorUnexpected, HSDCErrorNotInitialized, HSDCErrorInvalidLicense, HSDCErrorExpiredLicense, HSDCErrorVersionAlreadyInitialized, HSDCErrorVersionNotInitialized, HSDCErrorVersionNotSupported, HSDCErrorCryptoNotFunctionnal, HSDCErrorOSVersionNotSupported, HSDCErrorInvalidVolume, HSDCErrorSystemDrive, HSDCErrorAccessDenied, HSDCErrorAgentNotInstalled, HSDCErrorVolumeNotSupported, HSDCErrorServiceDoesntExist, HSDCErrorScomcCommFailure, HSDCErrorSkCommFailure, HSDCErrorInvalidIdentifier, HSDCErrorInvalidAlgorithm, HSDCErrorBufferTooSmall, HSDCErrorInvalidFile, HSDCErrorInvalidHeader, HSDCErrorInterrupted, HSDCErrorInvalidSync, HSDCErrorPending, HSDCErrorInvalidPassphrase, HSDCErrorUnlockFailure, HSDCErrorPasswordShort, HSDCErrorPasswordWeak, HSDCErrorExportFailure, HSDCErrorJsonParse, HSDCErrorJsonVerification, HSDCErrorClientOperationFailed, HSDCErrorUserADCert, HSDCErrorMax
}

The set of error values that may be returned from an API call.

Variables

const unsigned short ERROR_COUNT = (HSDCError::HSDCErrorMax - HSDCError::HSDCErrorNotImplemented) + 2

The number of valid error codes.

const wchar_t *const HSDCErrorNames [ERROR_COUNT]

The names of the error codes.

Enumeration Type Documentation

HSDCError

enum HSDCError

The set of error values a that may be returned from an API call.

Enumerator

HSDCErrorSuccess

The operation succeeded.

HSDCErrorNotImplemented

The function you are trying to use is not yet implemented.

HSDCErrorFailed

The operation failed.

HSDCErrorInvalidArg

The input parameters for the function are not valid. This is usually a failure to provide a value (nulls being passed) for a mandatory parameter.

HSDCErrorUnexpected

Unexpected error.

HSDCErrorNotInitialized

The API was not initialized correctly through the startup function.

HSDCErrorInvalidLicense

The license was not provided or is invalid.

HSDCErrorExpiredLicense

The license was provided but has expired.

HSDCErrorVersionAlreadyInitialized

The attempt to reinitialize failed because the API was already initialized. This is a warning.

HSDCErrorVersionNotInitialized

Initialization was not performed.

HSDCErrorVersionNotSupported

The requested version is not supported.

HSDCErrorCryptoNotFunctionnal

The initialization of the cryptographic engine failed.

HSDCErrorOSVersionNotSupported

The operating system is not supported.

HSDCErrorInvalidVolume

Unable to retrieve volume information.

HSDCErrorSystemDrive

The path references a volume on the system drive which is not monitored.

HSDCErrorAccessDenied

Unable to access required resources for the API call. This could be file paths, registry or services.

HSDCErrorAgentNotInstalled

Agent not installed and is required for multiple sessions disk.

HSDCErrorVolumeNotSupported

The volume format is not recognized or is unsupported.

HSDCErrorServiceDoesntExist

Configuration provided for a service or component that does not exist.

HSDCErrorScomcCommFailure

RPC communication to the underlying client interface failed.

HSDCErrorSkCommFailure

Unable to communicate with the kernel-mode components.

HSDCErrorInvalidIdentifier

Encryption identifier is not valid / supported.

HSDCErrorInvalidAlgorithm

Algorithm is not supported.

HSDCErrorBufferTooSmall

Length of the buffer is too small. This indicates a difference from an expectation.

HSDCErrorInvalidFile

Seek or Read operation failed.

HSDCErrorInvalidHeader

File does not contain a valid shadow header.

HSDCErrorInterrupted

A processor failed to successfully complete a callback event.

HSDCErrorInvalidSync

Unable to open client service event.

HSDCErrorPending

Unused.

HSDCErrorInvalidPassphrase

Decrypt attempt failed due to incorrect passphrase being supplied.

HSDCErrorUnlockFailure

Indicates that a volume or other piece of protected data was unable to be retrieved.

HSDCErrorPasswordShort

The provided password does not meet security criteria for length.

HSDCErrorPasswordWeak

The provided password does not meet security criteria for complexity.

HSDCErrorExportFailure

The export of a drive or information to a drive (for example during pwd recovery) was not successful.

HSDCErrorJsonParse

The provided string is not valid JSON. Use a JSON validator.

HSDCErrorJsonVerification

The JSON supplied did not meet the specified criteria for the API operation.

HSDCErrorClientOperationFailed

The operation was attempted at the client but failed to work.

HSDCErrorUserADCert

Unable to retrieve user's AD certificates.

HSDCErrorMax

Unused

Variable Documentation

ERROR_COUNT

const unsigned short ERROR_COUNT = (HSDCError::HSDCErrorMax - HSDCError::HSDCErrorNotImplemented) + 2

The number of valid error codes.

HSDCErrorNames

const wchar_t* const HSDCErrorNames[ERROR_COUNT]

The names of the error codes.