This commit is contained in:
blueloveTH 2024-04-26 15:59:26 +08:00
parent 6fcb215f8e
commit 9ea1fbb9ba

View File

@ -6,10 +6,7 @@ order: 10
### What C-API is for ### What C-API is for
The C-APIs are designed for these purposes: If your target platform does not support C++17. You can compile pkpy into a static library and use its exported C-APIs.
1. Your target platform does not support C++17. You compile pkpy into a static library and use its exported C-APIs.
2. You want to write a native module that can be imported via `__import__` at runtime. By using C-APIs, the module is portable across different compilers without C++ ABI compatibility issues.
Our C-APIs take a lot of inspiration from the lua C-APIs. Our C-APIs take a lot of inspiration from the lua C-APIs.
Methods return a `bool` indicating if the operation succeeded or not. Methods return a `bool` indicating if the operation succeeded or not.