Go to the documentation of this file.
6 #include "SIDXCConstants.h"
8 #ifndef SIDXCRoot_H
9 #define SIDXCRoot_H
19 __declspec(dllexport) int SIDXRootOpen(void*& SIDXroot, const wchar_t* license);
28 __declspec(dllexport) int SIDXRootClose(void* SIDXroot);
37 __declspec(dllexport) void SIDXRootGetLastError(void* SIDXroot, wchar_t* message, size_t length);
47 __declspec(dllexport) void SIDXRootEnableCapabilities(void* SIDXroot, int capability);
57 __declspec(dllexport) int SIDXRootArchiveOpen(void* SIDXroot, const wchar_t* path, void*& SIDXarchive);
70 __declspec(dllexport) int SIDXRootCameraScan(void* SIDXroot);
80 __declspec(dllexport) int SIDXRootCameraScanGetReport(void* SIDXroot, wchar_t* report, size_t length);
89 __declspec(dllexport) int SIDXRootCameraScanGetCount(void* SIDXroot, int& count);
100 __declspec(dllexport) int SIDXRootCameraScanGetName
101  (void* SIDXroot, int index, wchar_t* name, size_t length);
112 __declspec(dllexport) int SIDXRootCameraScanGetLabel
113  (void* SIDXroot, int index, wchar_t* label, size_t length);
126 __declspec(dllexport) int SIDXRootCameraOpenName
127  (void* SIDXroot, const wchar_t* name, void*& SIDXcamera);
139 __declspec(dllexport) int SIDXRootSoftwareGetDescription
140  (void* SIDXroot, wchar_t* description, size_t length);
150 __declspec(dllexport) int SIDXRootSoftwareGetLicense
151  (void* SIDXroot, wchar_t* license, size_t length);
161 __declspec(dllexport) int SIDXRootSoftwareGetSerial
162  (void* SIDXroot, wchar_t* serial, size_t length);
172 __declspec(dllexport) int SIDXRootSoftwareIsLicensed(void* SIDXroot, bool& licensed);
181 __declspec(dllexport) int SIDXRootSoftwareSetLicense(void* SIDXroot, const wchar_t* license);
193 __declspec(dllexport) int SIDXRootStageOpen
194  (void* SIDXroot, const wchar_t* name, const wchar_t* port, void*& SIDXstage);
196 #endif
int SIDXRootCameraScanGetCount(void *SIDXroot, int &count)
Return the number of connected camera count as the result of SIDXRootCameraScan.
int SIDXRootCameraOpenName(void *SIDXroot, const wchar_t *name, void *&SIDXcamera)
Connect to the specified camera by name.
File containing SIDX constants for reference.
int SIDXRootSoftwareSetLicense(void *SIDXroot, const wchar_t *license)
Sets an SIDX license.
void SIDXRootEnableCapabilities(void *SIDXroot, int capability)
Enable a special camera capability.
int SIDXRootSoftwareIsLicensed(void *SIDXroot, bool &licensed)
Verify if the SIDX software license is valid.
int SIDXRootCameraScanGetName(void *SIDXroot, int index, wchar_t *name, size_t length)
Obtain the name of the camera corresponding to the index.
int SIDXRootArchiveOpen(void *SIDXroot, const wchar_t *path, void *&SIDXarchive)
Open a file as an image archive.
int SIDXRootOpen(void *&SIDXroot, const wchar_t *license)
The function returns a handle used to control SIDX.
int SIDXRootCameraScanGetReport(void *SIDXroot, wchar_t *report, size_t length)
Obtain a detailed report of all available cameras on the system.
int SIDXRootClose(void *SIDXroot)
Close SIDX.
int SIDXRootCameraScanGetLabel(void *SIDXroot, int index, wchar_t *label, size_t length)
Obtain the label representing the camera.
int SIDXRootStageOpen(void *SIDXroot, const wchar_t *name, const wchar_t *port, void *&SIDXstage)
Open the stage controller, by name, on the specified port.
int SIDXRootSoftwareGetDescription(void *SIDXroot, wchar_t *description, size_t length)
Obtain the software description as a text string.
int SIDXRootCameraScan(void *SIDXroot)
This operation scans the computer system to locate any available cameras.
void SIDXRootGetLastError(void *SIDXroot, wchar_t *message, size_t length)
The function translates the last error into a text string.
int SIDXRootSoftwareGetLicense(void *SIDXroot, wchar_t *license, size_t length)
Obtain the software license string.
int SIDXRootSoftwareGetSerial(void *SIDXroot, wchar_t *serial, size_t length)
Obtain the software serial number as a text string.