|
1 | 1 | /* |
2 | | - * Copyright 2018-2021 ObjectBox Ltd. All rights reserved. |
| 2 | + * Copyright 2018-2022 ObjectBox Ltd. All rights reserved. |
3 | 3 | * |
4 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | 5 | * you may not use this file except in compliance with the License. |
@@ -51,7 +51,7 @@ extern "C" { |
51 | 51 | /// obx_version() or obx_version_is_at_least(). |
52 | 52 | #define OBX_VERSION_MAJOR 0 |
53 | 53 | #define OBX_VERSION_MINOR 15 |
54 | | -#define OBX_VERSION_PATCH 0 // values >= 100 are reserved for dev releases leading to the next minor/major increase |
| 54 | +#define OBX_VERSION_PATCH 1 // values >= 100 are reserved for dev releases leading to the next minor/major increase |
55 | 55 |
|
56 | 56 | //---------------------------------------------- |
57 | 57 | // Common types |
@@ -692,7 +692,9 @@ OBX_C_API OBX_store* obx_store_open(OBX_store_options* opt); |
692 | 692 | /// Check if an open store was found for the given path (i.e. opened before and not yet closed). |
693 | 693 | OBX_C_API bool obx_store_is_open(const char* path); |
694 | 694 |
|
695 | | -/// Get a store previously opened with createShared() matching the given path of the DB directory. |
| 695 | +/// Attach to a previously opened store matching the path of the DB directory, which was used for opening the store. |
| 696 | +/// The returned store is a new instance (e.g. different pointer value) with its own lifetime and must also be closed. |
| 697 | +/// The actual underlying store is only closed when the last store OBX_store instance is closed. |
696 | 698 | /// @returns nullptr if no open store was found (i.e. not opened before or already closed) |
697 | 699 | OBX_C_API OBX_store* obx_store_attach(const char* path); |
698 | 700 |
|
@@ -1829,7 +1831,7 @@ typedef struct OBX_admin OBX_admin; |
1829 | 1831 |
|
1830 | 1832 | /// Initialize the http-server with the given options. |
1831 | 1833 | /// Note: the given options are always freed by this function, including when an error occurs. |
1832 | | -/// @param opt required parameter holding the options (see obx_admin_opt_*()) |
| 1834 | +/// @param options required parameter holding the options (see obx_admin_opt_*()) |
1833 | 1835 | /// @returns NULL if the operation failed, see functions like obx_last_error_code() to get error details |
1834 | 1836 | OBX_C_API OBX_admin* obx_admin(OBX_admin_options* options); |
1835 | 1837 |
|
|
0 commit comments