.NET API
•Include file: -
•Library file: udkapinet.dll, resided in bin/[build]
•Namespace: cesys.ceUDK
The .NET API, as well as it example application is separated from the normal UDK build. First of all, CMake doesn't have native support .NET, as well as it is working on Windows systems only. Building it has no dependency to the standard UDKAPI, all required sources are part of the .NET API project. The Visual Studio solution is located in directory dotnet/ inside the UDK installation root. It is a Visual Studio 8/2005 solution and should be convertible to newer releases. The solution is split into two parts, the .NET API in mixed native/managed C++ and an example written in C#.
To use the .NET API in own projects, it's just needed to add the generated DLL udkapinet.dll to the projects references.
API Functions in detail
Notice: To prevent overhead in most usual scenarios, the API does not serialize calls in any way, so the API user is responsible to serialize call if used in a
Notice: The examples for .NET in the following chapter are in C# coding style.
API Error handling
Error handling is offered very different. While both C++ and .NET API use exception handling, the C API uses a classical return code / error inquiry scheme.
C++ and .NET API
UDK API code should be embedded inside a try branch and exceptions of type ceException must be caught. If an exception is raised, the generated exception object offers methods to get detailed information about the error.
C API
All UDK C API functions return either CE_SUCCESS or CE_FAILED. If the latter is returned, the functions below should be invoked to get the details of the error.
USBS6 / |
| http://www.cesys.com/ |
User Doc V0.3 | preliminary |