Gocator API
Home
Topics
Types
Files
All
Classes
Files
Functions
Variables
Typedefs
Macros
Modules
Pages
GoSdkLib.h
Go to the documentation of this file.
1
/**
2
* @file GoSdkLib.h
3
* @brief Gocator SDK library management functions.
4
*
5
* @internal
6
* Copyright (C) 2016-2021 by LMI Technologies Inc.
7
* Licensed under the MIT License.
8
* Redistributed files must retain the above copyright notice.
9
*/
10
#ifndef GO_SDK_LIB_H
11
#define GO_SDK_LIB_H
12
13
#include <
GoSdk/GoSdkDef.h
>
14
#include <
kApi/kAssembly.h
>
15
16
/**
17
*/
18
19
/**
20
* Constructs the Gocator SDK library.
21
*
22
* This function should be called prior to calling any other Gocator SDK functions.
23
* When the library is no longer needed, call kObject_Destroy on the assembly object
24
* that is returned by this function.
25
*
26
* This function can safely be called multiple times. In order to ensure
27
* final cleanup, kObject_Destroy must be invoked a corresponding number of times.
28
*
29
* @public
30
* @version Introduced in firmware 4.0.10.27
31
* @param assembly Receives an assembly object representing the GoSdk library.
32
* @return Operation status.
33
*/
34
GoFx(
kStatus
)
GoSdk_Construct
(
kAssembly
* assembly);
35
36
#include <GoSdk/GoSdkLib.x.h>
37
38
#endif
kAssembly
kAssembly.h
GoSdkDef.h
Essential SDK declarations.
GoSdk_Construct
kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
kStatus
GoSdkLib.h