VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
VxSdk::IVxQuickReport Struct Referenceabstract

Represents a quick system health report. More...

#include <IVxQuickReport.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetQuickReportEndpoint (char *endpoint, int &size)=0
 Gets the URI to the download location of the quick report. The endpoint will only be available if the VideoXpert system has completed generating the report. More...
 
virtual VxResult::Value GetStatus (VxReportCreationStatus::Value &status)=0
 Gets the current status of creating the report. More...
 

Detailed Description

Represents a quick system health report.

Definition at line 12 of file IVxQuickReport.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxQuickReport::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxQuickReport::GetQuickReportEndpoint ( char *  endpoint,
int &  size 
)
pure virtual

Gets the URI to the download location of the quick report. The endpoint will only be available if the VideoXpert system has completed generating the report.

Parameters
endpointThe quick report endpoint, if available.
sizeThe size of endpoint .
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxQuickReport::GetStatus ( VxReportCreationStatus::Value status)
pure virtual

Gets the current status of creating the report.

Parameters
statusThe current status of creating the report.
Returns
The Result of the request.

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