Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoSdkLib.h
Go to the documentation of this file.
1 /**
2  * @file GoSdkLib.h
3  * @brief Gocator API library management functions.
4  *
5  * @internal
6  * Copyright (C) 2011-2012 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>
16 
17 /**
18  * Constructs the Gocator API library.
19  *
20  * This function should be called prior to calling any other Gocator API functions.
21  * When the library is no longer needed, call kObject_Destroy on the assembly object
22  * that is returned by this function.
23  *
24  * This function can safely be called multiple times. In order to ensure
25  * final cleanup, kObject_Destroy must be invoked a corresponding number of times.
26  *
27  * @param assembly Receives an assembly object representing the GoSdk library.
28  * @return Operation status.
29  */
30 GoFx(kStatus) GoSdk_Construct(kAssembly* assembly);
31 
32 kEndHeader()
33 #include <GoSdk/GoSdkLib.x.h>
34 
35 #endif
Essential API declarations.
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator API library.