C++/CLI Sample
Demonstrates how to create a C++/CLI library using the VideoXpert SDK
CPPCli::Results Class Reference

The Results class is a helper class that contains the Results enum. More...

#include <Utils.h>

Public Types

enum  Value {
  Value::UnknownError,
  Value::OK,
  Value::UnsupportedVersion,
  Value::InsufficientSize,
  Value::InvalidLoginInfo,
  Value::ActionUnavailable,
  Value::InvalidParameters,
  Value::CommunicationError,
  Value::InvalidLicense,
  Value::CameraUnavailable,
  Value::EdgeOfStream,
  Value::EndOfStream,
  Value::NoAvailableStreams,
  Value::StorageUnavailable,
  Value::ExportDataUnretrievable,
  Value::ExportStorageFull,
  Value::ExportStorageUnauthenticated,
  Value::ExportStorageUnavailable,
  Value::Conflict,
  Value::InsufficientResources,
  Value::NotReady,
  Value::NotReadyUnauthenticated,
  Value::NotReadyUnauthorized,
  Value::OperationFailed,
  Value::ResponseTooLarge,
  Value::ActivationConflict,
  Value::ActivationHostNotFound,
  Value::ActivationFailed,
  Value::IncompatibleLicense,
  Value::LicenseCountExceeded,
  Value::LicenseRequired,
  Value::LicenseReqLdapAdmin,
  Value::NoLicense,
  Value::CameraInUse,
  Value::CameraLocked,
  Value::NeedOverride,
  Value::InvalidValue,
  Value::PortInUse,
  Value::ReadOnlyField,
  Value::ResourceLocked,
  Value::AuthExpired,
  Value::PasswordReqMoreDigits,
  Value::PasswordReqMoreLower,
  Value::PasswordReqMoreSpecial,
  Value::PasswordReqMoreUpper,
  Value::PasswordTooShort,
  Value::PasswordTooSimilar,
  Value::PermissionConflict,
  Value::Unauthenticated,
  Value::Unauthorized
}
 Values that represent the result of calls to the VideoXpert system. More...
 

Detailed Description

The Results class is a helper class that contains the Results enum.

Definition at line 15 of file Utils.h.

Member Enumeration Documentation

Values that represent the result of calls to the VideoXpert system.

Enumerator
UnknownError 

An error or unknown value was returned.

OK 

The action was successful.

UnsupportedVersion 

The VideoXpert system version is not supported.

InsufficientSize 

The size value was not sufficient enough to allocate the collection.

InvalidLoginInfo 

The login credentials were invalid.

ActionUnavailable 

The attempted action is unsupported by the system.

InvalidParameters 

A parameter was invalid.

CommunicationError 

There was an error communicating to the device.

InvalidLicense 

No valid license was found on the VideoXpert system.

CameraUnavailable 

Camera is unavailable, data cannot be retrieved at this time.

EdgeOfStream 

No further stream data is currently available (the edge of a currently recording clip has been reached); more data will be available shortly.

EndOfStream 

No further stream data is available (the end of all recorded data has been reached; no further data is currently be recorded).

NoAvailableStreams 

The server is unable to initiate any new stream sessions due to having reached its stream count capacity.

StorageUnavailable 

Storage is unavailable, data cannot be retrieved at this time.

ExportDataUnretrievable 

The data needed to perform the export operation can not be retrieved.

ExportStorageFull 

The export storage location does not have enough free space to store the export.

ExportStorageUnauthenticated 

The export storage location is not accessible due to invalid credentials.

ExportStorageUnavailable 

The export storage location is not accessible; this may be due to an invalid location, network issue, or storage issue.

Conflict 

The requested operation is not possible due to a conflict with the resource. Typically this is due to a violation of a uniqueness property on one of the resource’s fields.

InsufficientResources 

The server has insufficient resources to satisfy the request.

NotReady 

The server is not in an appropriate state to be able to service this request. The server requires intervention in order to resolve this.

NotReadyUnauthenticated 

The server is not in an appropriate state to be able to service this request due to an authentication issue between it and another entity. The server requires intervention in order to resolve this.

NotReadyUnauthorized 

The server is not in an appropriate state to be able to service this request due to an authorization issue between it and another entity. The server requires intervention in order to resolve this.

OperationFailed 

The requested operation failed.

ResponseTooLarge 

The server is incapable of handling the client request due to the size of the resulting response.What constitutes ’too large’ is entirely up to the server.

ActivationConflict 

The license that was supplied has an activation conflict with an existing license(e.g.duplicate activation IDs).

ActivationHostNotFound 

The activation failed due to communication error with the FNO licensing server.

ActivationFailed 

The activation failed.

IncompatibleLicense 

The license that was supplied is not compatible with the device and/or system that it is being applied to.

LicenseCountExceeded 

A valid license is available but the available count on that license is fully utilized.

LicenseRequired 

A valid license is required to utilize this method on the resource; no valid license found.

LicenseReqLdapAdmin 

Unable to apply the license; valid LDAP administrator credentials are required.

NoLicense 

Unable to commission (or float) a feature because no valid license is available for it.

CameraInUse 

Camera is in use (or the usage dwell time is active) by same or higher authority user.

CameraLocked 

Camera is locked by same or higher authority user.

NeedOverride 

Locked by lower authority user, may override.

InvalidValue 

An attempt to set an invalid value on a writable field was made. The value may be invalid due to being out of range, unavailable, etc.

PortInUse 

An attempt to set a new port number failed because the port number is already in use.

ReadOnlyField 

An attempt to edit a read-only field was made.

ResourceLocked 

An attempt to edit a locked resource was made by a user that does not own the IVxResourceLock.

AuthExpired 

A request was made using expired authentication credentials.

PasswordReqMoreDigits 

A password with an insufficient number of digits was supplied in an attempt to create a new user password.

PasswordReqMoreLower 

A password with an insufficient number of lowercase letters was supplied in an attempt to create a new user password.

PasswordReqMoreSpecial 

A password with an insufficient number of special characters was supplied in an attempt to create a new user password.

PasswordReqMoreUpper 

A password with an insufficient number of uppercase letters was supplied in an attempt to create a new user password.

PasswordTooShort 

A password of insufficient length was supplied in an attempt to create a new user password.

PasswordTooSimilar 

A password too similar to a previous password was supplied in an attempt to create a new user password.

PermissionConflict 

The requested operation is not possible due to a permission conflict with the resource. Typically this is due to a violation of permission hierarchy (e.g. a nested permission is being assigned without its parent permission already assigned).

Unauthenticated 

An unauthenticated request was made (i.e. invalid username and/or password).

Unauthorized 

An unauthorized request was made (i.e. user does not have permission to access the resource).

Definition at line 21 of file Utils.h.

21  {
23  UnknownError,
24 
26  OK,
27 
29  UnsupportedVersion,
30 
32  InsufficientSize,
33 
35  InvalidLoginInfo,
36 
38  ActionUnavailable,
39 
41  InvalidParameters,
42 
44  CommunicationError,
45 
47  InvalidLicense,
48 
50  CameraUnavailable,
51 
56  EdgeOfStream,
57 
61  EndOfStream,
62 
64  NoAvailableStreams,
65 
67  StorageUnavailable,
68 
70  ExportDataUnretrievable,
71 
73  ExportStorageFull,
74 
76  ExportStorageUnauthenticated,
77 
81  ExportStorageUnavailable,
82 
87  Conflict,
88 
90  InsufficientResources,
91 
96  NotReady,
97 
102  NotReadyUnauthenticated,
103 
108  NotReadyUnauthorized,
109 
111  OperationFailed,
112 
117  ResponseTooLarge,
118 
120  ActivationConflict,
121 
123  ActivationHostNotFound,
124 
126  ActivationFailed,
127 
129  IncompatibleLicense,
130 
132  LicenseCountExceeded,
133 
135  LicenseRequired,
136 
138  LicenseReqLdapAdmin,
139 
141  NoLicense,
142 
144  CameraInUse,
145 
147  CameraLocked,
148 
150  NeedOverride,
151 
155  InvalidValue,
156 
158  PortInUse,
159 
161  ReadOnlyField,
162 
164  ResourceLocked,
165 
167  AuthExpired,
168 
170  PasswordReqMoreDigits,
171 
173  PasswordReqMoreLower,
174 
176  PasswordReqMoreSpecial,
177 
179  PasswordReqMoreUpper,
180 
182  PasswordTooShort,
183 
185  PasswordTooSimilar,
186 
191  PermissionConflict,
192 
194  Unauthenticated,
195 
197  Unauthorized
198  };

The documentation for this class was generated from the following file: