Represents a point in time of interest with reference to a particular data source. More...

#include <IVxBookmark.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteBookmark () const =0
	Delete this bookmark from the VideoXpert system. More...

virtual VxResult::Value	GetDataSource (IVxDataSource *&dataSource) const =0
	Gets the data source associated with this bookmark. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	SetDescription (char description[255])=0
	Sets the description property. More...

virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...

Public Attributes
char	description [255]
	The friendly description of the bookmark. More...

char	id [64]
	The unique identifier of the bookmark. More...

char	name [64]
	The friendly name of the bookmark. More...

char	time [64]
	The time at which the point of interest occurred. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a point in time of interest with reference to a particular data source.

Definition at line 13 of file IVxBookmark.h.

Member Function Documentation

void VxSdk::IVxBookmark::Clear ( )

inlineprotected

Clears this instance.

Definition at line 71 of file IVxBookmark.h.

                      {
             VxZeroArray(this->description);
             VxZeroArray(this->id);
             VxZeroArray(this->name);
             VxZeroArray(this->time);
         }

virtual VxResult::Value VxSdk::IVxBookmark::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxBookmark::DeleteBookmark ( ) const

pure virtual

Delete this bookmark from the VideoXpert system.

Returns: The Result of deleting the bookmark.

virtual VxResult::Value VxSdk::IVxBookmark::GetDataSource ( IVxDataSource *& dataSource ) const

pure virtual

Gets the data source associated with this bookmark.

Parameters

dataSource The associated data source.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxBookmark::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxBookmark::SetDescription ( char description[255] )

pure virtual

Sets the description property.

Parameters

description The new description value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxBookmark::SetName ( char name[64] )

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns: The Result of setting the property.

Member Data Documentation

char VxSdk::IVxBookmark::description[255]

The friendly description of the bookmark.

Definition at line 53 of file IVxBookmark.h.

char VxSdk::IVxBookmark::id[64]

The unique identifier of the bookmark.

Definition at line 57 of file IVxBookmark.h.

char VxSdk::IVxBookmark::name[64]

The friendly name of the bookmark.

Definition at line 61 of file IVxBookmark.h.

char VxSdk::IVxBookmark::time[64]

The time at which the point of interest occurred.

Definition at line 65 of file IVxBookmark.h.

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

C:/Git/VXSDK_M3/VxSdk/Include/IVxBookmark.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation