VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxResourceLock Struct Referenceabstract

Represents a lock upon a resource. A resource that has been locked shall permit only the owner of the lock access to modify the resource. More...

#include <IVxResourceLock.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value DeleteResourceLock () const =0
 Deletes this lock from the VideoXpert system. More...
 

Public Attributes

char id [64]
 The unique identifier of the lock. More...
 
char owner [64]
 The name of the user that owns the lock. Only this user is authorized to modify the resource that owns this lock. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

Represents a lock upon a resource. A resource that has been locked shall permit only the owner of the lock access to modify the resource.

Definition at line 13 of file IVxResourceLock.h.

Member Function Documentation

void VxSdk::IVxResourceLock::Clear ( )
inlineprotected

Clears this instance.

Definition at line 41 of file IVxResourceLock.h.

41  {
42  VxZeroArray(this->id);
43  VxZeroArray(this->owner);
44  }
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxResourceLock::owner
char owner[64]
The name of the user that owns the lock. Only this user is authorized to modify the resource that own...
Definition: IVxResourceLock.h:35
virtual VxResult::Value VxSdk::IVxResourceLock::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxResourceLock::DeleteResourceLock ( ) const
pure virtual

Deletes this lock from the VideoXpert system.

Returns
The Result of deleting the ResourceLock.

Member Data Documentation

char VxSdk::IVxResourceLock::id[64]

The unique identifier of the lock.

Definition at line 30 of file IVxResourceLock.h.

char VxSdk::IVxResourceLock::owner[64]

The name of the user that owns the lock. Only this user is authorized to modify the resource that owns this lock.

Definition at line 35 of file IVxResourceLock.h.

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