OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
LHUserStringAPI.h
Go to the documentation of this file.
1#ifndef LH_USER_STRING_API_H
2#define LH_USER_STRING_API_H
3/*****************************************************
4 * @file LHUserStringAPI.h
5 * @date December 2023
6 * @author Ocean Insight, Inc.
7 *
8 * This is an interface to OceanDirect that allows
9 * the user to connect to devices over USB and other buses.
10 * This is intended as a usable and extensible API.
11 */
12 /************************************************************************
13 *
14 * OCEAN INSIGHT CONFIDENTIAL
15 * __________________
16 *
17 * [2018] - [2023] Ocean Insight Incorporated
18 * All Rights Reserved.
19 *
20 * NOTICE: All information contained herein is, and remains
21 * the property of Ocean Insight Incorporated and its suppliers,
22 * if any. The intellectual and technical concepts contained
23 * herein are proprietary to Ocean Insight Incorporated
24 * and its suppliers and may be covered by U.S. and Foreign Patents,
25 * patents in process, and are protected by trade secret or copyright law.
26 * Dissemination of this information or reproduction of this material
27 * is strictly forbidden unless prior written permission is obtained
28 * from Ocean Insight Incorporated.
29 *
30 **************************************************************************/
31
32#include "lighthouse/api/LighthouseDllDecl.h"
37namespace oceandirect {
38 namespace api {
39 class LIGHTHOUSE_DLL_DECL LHUserStringAPI {
40 public:
41 virtual ~LHUserStringAPI() = default;
42
51 virtual void setUserString(lh_device_id_t deviceID, lh_error_code_t* errorCode, const char buffer[], size_t bufferLength);
52
61 virtual size_t getUserString(lh_device_id_t deviceID, lh_error_code_t* errorCode, char buffer[], size_t bufferLength);
62 };
63 }
64}
65#endif /* LH_USER_STRING_API_H */
Definition LHUserStringAPI.h:39
virtual size_t getUserString(lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
virtual void setUserString(lh_device_id_t deviceID, lh_error_code_t *errorCode, const char buffer[], size_t bufferLength)
virtual ~LHUserStringAPI()=default
int32_t lh_error_code_t
Definition lhdefs.h:47
uint32_t lh_device_id_t
Definition lhdefs.h:43
This is the API for controlling the autonulling functionality of a device.
Definition LighthouseAPI.h:54