btrievePython 16.10.30.0b1__tar.gz → 16.10.51.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. {btrievepython-16.10.30.0b1/btrievePython.egg-info → btrievepython-16.10.51.0}/PKG-INFO +5 -3
  2. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/README.md +3 -1
  3. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/btrievePython/__init__.py +0 -101
  4. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/btrievePython/btrieveC.h +26 -66
  5. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/btrievePython/btrieveCpp.h +33 -450
  6. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/btrievePython/btrievePython.cpp +442 -3435
  7. btrievepython-16.10.51.0/btrievePython/win32/btrieveCpp.lib +0 -0
  8. btrievepython-16.10.51.0/btrievePython/win64/btrieveCpp.lib +0 -0
  9. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0/btrievePython.egg-info}/PKG-INFO +5 -3
  10. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/pyproject.toml +2 -4
  11. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/setup.cfg +2 -2
  12. btrievepython-16.10.30.0b1/btrievePython/win32/btrieveCpp.lib +0 -0
  13. btrievepython-16.10.30.0b1/btrievePython/win64/btrieveCpp.lib +0 -0
  14. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/LICENSE.txt +0 -0
  15. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/MANIFEST.in +0 -0
  16. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/btrievePython.egg-info/SOURCES.txt +0 -0
  17. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/btrievePython.egg-info/dependency_links.txt +0 -0
  18. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/btrievePython.egg-info/top_level.txt +0 -0
  19. {btrievepython-16.10.30.0b1 → btrievepython-16.10.51.0}/setup.py +0 -0
@@ -1,7 +1,7 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: btrievePython
3
- Version: 16.10.30.0b1
4
- Summary: Btrieve Python provides a Client API for Actian Zen
3
+ Version: 16.10.51.0
4
+ Summary: The Btrieve Python PyPI package provides the Actian Zen Btrieve2 interface
5
5
  Home-page: https://www.actian.com/databases/zen
6
6
  Author: Actian Corporation
7
7
  Author-email: community.admin@actian.com
@@ -188,8 +188,10 @@ Description-Content-Type: text/markdown
188
188
  License-File: LICENSE.txt
189
189
  Dynamic: license-file
190
190
 
191
- Btrieve Python provides a Client for Actian Zen.
191
+ The Btrieve Python PyPI package provides the Actian Zen Btrieve2 interface.
192
192
 
193
193
  Actian Zen is a database management system offered by the Actian Corporation.
194
194
 
195
195
  To use this package an Actian Zen Client or Server must be installed locally. To download Actian Zen visit https://esd.actian.com/product.
196
+
197
+ To access the Btrieve2 interface documentation visit https://docs.actian.com/zen.
@@ -1,5 +1,7 @@
1
- Btrieve Python provides a Client for Actian Zen.
1
+ The Btrieve Python PyPI package provides the Actian Zen Btrieve2 interface.
2
2
 
3
3
  Actian Zen is a database management system offered by the Actian Corporation.
4
4
 
5
5
  To use this package an Actian Zen Client or Server must be installed locally. To download Actian Zen visit https://esd.actian.com/product.
6
+
7
+ To access the Btrieve2 interface documentation visit https://docs.actian.com/zen.
@@ -76,7 +76,6 @@ class Btrieve(object):
76
76
  MAXIMUM_RECORD_LENGTH = _btrievePython.Btrieve_MAXIMUM_RECORD_LENGTH
77
77
  MAXIMUM_KEY_LENGTH = _btrievePython.Btrieve_MAXIMUM_KEY_LENGTH
78
78
  MAXIMUM_BULK_RECORD_COUNT = _btrievePython.Btrieve_MAXIMUM_BULK_RECORD_COUNT
79
- MAXIMUM_SPACE_DIMENSIONS = _btrievePython.Btrieve_MAXIMUM_SPACE_DIMENSIONS
80
79
  ACS_MODE_NONE = _btrievePython.Btrieve_ACS_MODE_NONE
81
80
  ACS_MODE_NAMED = _btrievePython.Btrieve_ACS_MODE_NAMED
82
81
  ACS_MODE_NUMBERED = _btrievePython.Btrieve_ACS_MODE_NUMBERED
@@ -833,21 +832,6 @@ class BtrieveClient(object):
833
832
  def CollectionClose(self, btrieveCollection: "BtrieveCollection") -> "Btrieve::StatusCode":
834
833
  return _btrievePython.BtrieveClient_CollectionClose(self, btrieveCollection)
835
834
 
836
- def SpaceCreate(self, spaceName: "char const *", dimensions: "int") -> "Btrieve::StatusCode":
837
- return _btrievePython.BtrieveClient_SpaceCreate(self, spaceName, dimensions)
838
-
839
- def SpaceDelete(self, spaceName: "char const *") -> "Btrieve::StatusCode":
840
- return _btrievePython.BtrieveClient_SpaceDelete(self, spaceName)
841
-
842
- def SpaceRename(self, existingSpaceName: "char const *", newSpaceName: "char const *") -> "Btrieve::StatusCode":
843
- return _btrievePython.BtrieveClient_SpaceRename(self, existingSpaceName, newSpaceName)
844
-
845
- def SpaceOpen(self, btrieveSpace: "BtrieveSpace", spaceName: "char const *", password: "char const *"=None) -> "Btrieve::StatusCode":
846
- return _btrievePython.BtrieveClient_SpaceOpen(self, btrieveSpace, spaceName, password)
847
-
848
- def SpaceClose(self, btrieveSpace: "BtrieveSpace") -> "Btrieve::StatusCode":
849
- return _btrievePython.BtrieveClient_SpaceClose(self, btrieveSpace)
850
-
851
835
  def FileCreate(self, *args) -> "Btrieve::StatusCode":
852
836
  return _btrievePython.BtrieveClient_FileCreate(self, *args)
853
837
 
@@ -1461,15 +1445,6 @@ class BtrieveBulkRetrieveAttributes(object):
1461
1445
  def SetSkipCurrentRecord(self, skipCurrentRecord: "bool") -> "Btrieve::StatusCode":
1462
1446
  return _btrievePython.BtrieveBulkRetrieveAttributes_SetSkipCurrentRecord(self, skipCurrentRecord)
1463
1447
 
1464
- def AddCosineSimilarity(self, vectorObject: "PyObject *", offset: "int") -> "Btrieve::StatusCode":
1465
- return _btrievePython.BtrieveBulkRetrieveAttributes_AddCosineSimilarity(self, vectorObject, offset)
1466
-
1467
- def AddEuclideanDistanceSimilarity(self, vectorObject: "PyObject *", offset: "int") -> "Btrieve::StatusCode":
1468
- return _btrievePython.BtrieveBulkRetrieveAttributes_AddEuclideanDistanceSimilarity(self, vectorObject, offset)
1469
-
1470
- def AddDotProductSimilarity(self, vectorObject: "PyObject *", offset: "int") -> "Btrieve::StatusCode":
1471
- return _btrievePython.BtrieveBulkRetrieveAttributes_AddDotProductSimilarity(self, vectorObject, offset)
1472
-
1473
1448
  # Register BtrieveBulkRetrieveAttributes in _btrievePython:
1474
1449
  _btrievePython.BtrieveBulkRetrieveAttributes_swigregister(BtrieveBulkRetrieveAttributes)
1475
1450
 
@@ -1822,81 +1797,5 @@ def BRestful_GET(*args) -> "char const *":
1822
1797
  def BRestful_PUT(*args) -> "char const *":
1823
1798
  return _btrievePython.BRestful_PUT(*args)
1824
1799
 
1825
- class BtrieveSpace(object):
1826
- thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1827
- __repr__ = _swig_repr
1828
-
1829
- def __init__(self):
1830
- _btrievePython.BtrieveSpace_swiginit(self, _btrievePython.new_BtrieveSpace())
1831
- __swig_destroy__ = _btrievePython.delete_BtrieveSpace
1832
-
1833
- def VectorRetrieveEntityTag(self, id: "int") -> "int":
1834
- return _btrievePython.BtrieveSpace_VectorRetrieveEntityTag(self, id)
1835
-
1836
- def VectorDelete(self, id: "int", entityTag: "int"=-1) -> "Btrieve::StatusCode":
1837
- return _btrievePython.BtrieveSpace_VectorDelete(self, id, entityTag)
1838
-
1839
- def Query(self, btrieveVectorSet: "BtrieveVectorSet", query: "char const *"=None) -> "Btrieve::StatusCode":
1840
- return _btrievePython.BtrieveSpace_Query(self, btrieveVectorSet, query)
1841
-
1842
- def Encrypt(self, password: "char const *", passwordAgain: "char const *") -> "Btrieve::StatusCode":
1843
- return _btrievePython.BtrieveSpace_Encrypt(self, password, passwordAgain)
1844
-
1845
- def Decrypt(self) -> "Btrieve::StatusCode":
1846
- return _btrievePython.BtrieveSpace_Decrypt(self)
1847
-
1848
- def GetLastStatusCode(self) -> "Btrieve::StatusCode":
1849
- return _btrievePython.BtrieveSpace_GetLastStatusCode(self)
1850
-
1851
- def SetLastStatusCode(self, statusCode: "Btrieve::StatusCode") -> "Btrieve::StatusCode":
1852
- return _btrievePython.BtrieveSpace_SetLastStatusCode(self, statusCode)
1853
-
1854
- def EuclideanDistanceSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "std::string":
1855
- return _btrievePython.BtrieveSpace_EuclideanDistanceSimilarity(self, vector, limit, query)
1856
-
1857
- def CosineSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "std::string":
1858
- return _btrievePython.BtrieveSpace_CosineSimilarity(self, vector, limit, query)
1859
-
1860
- def DotProductSimilarity(self, vector: "char const *", limit: "int", query: "char const *"=None) -> "std::string":
1861
- return _btrievePython.BtrieveSpace_DotProductSimilarity(self, vector, limit, query)
1862
-
1863
- def VectorCreate(self, *args) -> "int":
1864
- return _btrievePython.BtrieveSpace_VectorCreate(self, *args)
1865
-
1866
- def VectorRetrieveBlob(self, *args) -> "Btrieve::StatusCode":
1867
- return _btrievePython.BtrieveSpace_VectorRetrieveBlob(self, *args)
1868
-
1869
- def VectorRetrieveJson(self, *args) -> "std::string":
1870
- return _btrievePython.BtrieveSpace_VectorRetrieveJson(self, *args)
1871
-
1872
- def VectorUpdate(self, *args) -> "Btrieve::StatusCode":
1873
- return _btrievePython.BtrieveSpace_VectorUpdate(self, *args)
1874
-
1875
- # Register BtrieveSpace in _btrievePython:
1876
- _btrievePython.BtrieveSpace_swigregister(BtrieveSpace)
1877
-
1878
- class BtrieveVectorSet(object):
1879
- thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
1880
- __repr__ = _swig_repr
1881
-
1882
- def __init__(self):
1883
- _btrievePython.BtrieveVectorSet_swiginit(self, _btrievePython.new_BtrieveVectorSet())
1884
- __swig_destroy__ = _btrievePython.delete_BtrieveVectorSet
1885
-
1886
- def Size(self) -> "int":
1887
- return _btrievePython.BtrieveVectorSet_Size(self)
1888
-
1889
- def PopFirst(self) -> "int":
1890
- return _btrievePython.BtrieveVectorSet_PopFirst(self)
1891
-
1892
- def PopLast(self) -> "int":
1893
- return _btrievePython.BtrieveVectorSet_PopLast(self)
1894
-
1895
- def GetLastStatusCode(self) -> "Btrieve::StatusCode":
1896
- return _btrievePython.BtrieveVectorSet_GetLastStatusCode(self)
1897
-
1898
- # Register BtrieveVectorSet in _btrievePython:
1899
- _btrievePython.BtrieveVectorSet_swigregister(BtrieveVectorSet)
1900
-
1901
1800
 
1902
1801
 
@@ -1494,60 +1494,6 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkCreateResultFree(btrieve_bulk_cr
1494
1494
  /// \see BtrieveStatusCodeToString
1495
1495
  extern LINKAGE btrieve_status_code_t BtrieveBulkCreateResultGetLastStatusCode(btrieve_bulk_create_result_t bulkCreateResult);
1496
1496
 
1497
- /// \brief Add a cosine similarity.
1498
- /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
1499
- /// \param[in] vector The vector. Must point at an array of 32-bit floating point numbers.
1500
- /// \param[in] vectorLength The vector length in bytes. Vector length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1501
- /// \param[in] offset The offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.
1502
- /// \par \DESCRIPTION
1503
- /// Computes the similarity between the passed in vector and the vector specified by offset.
1504
- /// Bulk retrieve attributes have no similarities initially.
1505
- /// \OFFSET_PLUS_LENGTH_C
1506
- /// The vectors specified must be in little endian format.
1507
- /// Only one similarity may be added to the same bulk retrieve.
1508
- /// Aggregates and fields may not be added to a bulk retrieve attributes containing a similarity.
1509
- /// The returned similarity is a 32-bit floating point number.
1510
- /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1511
- /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1512
- /// \see BtrieveStatusCodeToString
1513
- extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddCosineSimilarity(btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, const char *vector, int vectorLength, int offset);
1514
-
1515
- /// \brief Add a dot product similarity.
1516
- /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
1517
- /// \param[in] vector The vector. Must point at an array of 32-bit floating point numbers.
1518
- /// \param[in] vectorLength The vector length in bytes. Vector length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1519
- /// \param[in] offset The offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.
1520
- /// \par \DESCRIPTION
1521
- /// Computes the similarity between the passed in vector and the vector specified by offset.
1522
- /// Bulk retrieve attributes have no similarities initially.
1523
- /// \OFFSET_PLUS_LENGTH_C
1524
- /// The vectors specified must be in little endian format.
1525
- /// Only one similarity may be added to the same bulk retrieve.
1526
- /// Aggregates and fields may not be added to a bulk retrieve attributes containing a similarity.
1527
- /// The returned similarity is a 32-bit floating point number.
1528
- /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1529
- /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1530
- /// \see BtrieveStatusCodeToString
1531
- extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddDotProductSimilarity(btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, const char *vector, int vectorLength, int offset);
1532
-
1533
- /// \brief Add an Euclidean distance similarity.
1534
- /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
1535
- /// \param[in] vector The vector. Must point at an array of 32-bit floating point numbers.
1536
- /// \param[in] vectorLength The vector length in bytes. Vector length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1537
- /// \param[in] offset The offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.
1538
- /// \par \DESCRIPTION
1539
- /// Computes the similarity between the passed in vector and the vector specified by offset.
1540
- /// Bulk retrieve attributes have no similarities initially.
1541
- /// \OFFSET_PLUS_LENGTH_C
1542
- /// The vectors specified must be in little endian format.
1543
- /// Only one similarity may be added to the same bulk retrieve.
1544
- /// Aggregates and fields may not be added to a bulk retrieve attributes containing a similarity.
1545
- /// The returned similarity is a 32-bit floating point number.
1546
- /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1547
- /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1548
- /// \see BtrieveStatusCodeToString
1549
- extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddEuclideanDistanceSimilarity(btrieve_bulk_retrieve_attributes_t bulkRetrieveAttributes, const char *vector, int vectorLength, int offset);
1550
-
1551
1497
  /// \brief Add a minimum aggregate to a %Btrieve bulk retrieve attributes
1552
1498
  /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
1553
1499
  /// \param[in] dataType The data type. Only BTRIEVE_DATA_TYPE_INTEGER and BTRIEVE_DATA_TYPE_FLOAT are supported.
@@ -1574,7 +1520,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddMinimumAggr
1574
1520
  /// \OFFSET_PLUS_LENGTH_C
1575
1521
  /// The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1576
1522
  /// The field specified by offset and length must be in little endian format.
1577
- /// Similarities and fields may not be added to a bulk retrieve attributes containing an aggregate.
1523
+ /// Fields may not be added to a bulk retrieve attributes containing an aggregate.
1578
1524
  /// Aggregates and fields may not be added to the same bulk retrieve.
1579
1525
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1580
1526
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
@@ -1589,7 +1535,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddMaximumAggr
1589
1535
  /// Bulk retrieve attributes have no fields initially.
1590
1536
  /// \OFFSET_PLUS_LENGTH_C
1591
1537
  /// The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1592
- /// Similarities and aggregates may not be added to a bulk retrieve attributes containing a field.
1538
+ /// Aggregates may not be added to a bulk retrieve attributes containing a field.
1593
1539
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1594
1540
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1595
1541
  /// \see BtrieveStatusCodeToString
@@ -1605,7 +1551,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddField(btrie
1605
1551
  /// \OFFSET_PLUS_LENGTH_C
1606
1552
  /// The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1607
1553
  /// The field specified by offset and length must be in little endian format.
1608
- /// Similarities and aggregates may not be added to a bulk retrieve attributes containing a field.
1554
+ /// Aggregates may not be added to a bulk retrieve attributes containing a field.
1609
1555
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1610
1556
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1611
1557
  /// \see BtrieveStatusCodeToString
@@ -1621,7 +1567,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddAbsoluteVal
1621
1567
  /// \OFFSET_PLUS_LENGTH_C
1622
1568
  /// The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1623
1569
  /// The field specified by offset and length must be in little endian format.
1624
- /// Similarities and aggregates may not be added to a bulk retrieve attributes containing a field.
1570
+ /// Aggregates may not be added to a bulk retrieve attributes containing a field.
1625
1571
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1626
1572
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1627
1573
  /// \see BtrieveStatusCodeToString
@@ -1637,7 +1583,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddCeilingFiel
1637
1583
  /// \OFFSET_PLUS_LENGTH_C
1638
1584
  /// The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1639
1585
  /// The field specified by offset and length must be in little endian format.
1640
- /// Similarities and aggregates may not be added to a bulk retrieve attributes containing a field.
1586
+ /// Aggregates may not be added to a bulk retrieve attributes containing a field.
1641
1587
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1642
1588
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1643
1589
  /// \see BtrieveStatusCodeToString
@@ -1649,7 +1595,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddFloorField(
1649
1595
  /// \param[in] offset The offset. Offset must be less than BTRIEVE_MAXIMUM_RECORD_LENGTH.
1650
1596
  /// \param[in] length The length. Length is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1651
1597
  /// \param[in] precision The precision. Precision must be in the range INT16_MIN to INT16_MAX, inclusive.
1652
- /// Similarities and aggregates may not be added to a bulk retrieve attributes containing a field.
1598
+ /// Aggregates may not be added to a bulk retrieve attributes containing a field.
1653
1599
  /// \par \DESCRIPTION
1654
1600
  /// Bulk retrieve attributes have no fields initially.
1655
1601
  /// \OFFSET_PLUS_LENGTH_C
@@ -1671,7 +1617,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddRoundField(
1671
1617
  /// \OFFSET_PLUS_LENGTH_C
1672
1618
  /// The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1673
1619
  /// The field specified by offset and length must be in little endian format.
1674
- /// Similarities and aggregates may not be added to a bulk retrieve attributes containing a field.
1620
+ /// Aggregates may not be added to a bulk retrieve attributes containing a field.
1675
1621
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1676
1622
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1677
1623
  /// \see BtrieveStatusCodeToString
@@ -1683,7 +1629,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesAddTruncateFie
1683
1629
  /// \par \DESCRIPTION
1684
1630
  /// Bulk retrieve attributes have no system fields initially.
1685
1631
  /// The sum of the lengths of all added fields is limited to BTRIEVE_MAXIMUM_RECORD_LENGTH.
1686
- /// Similarities and aggregates may not be added to a bulk retrieve attributes containing a field.
1632
+ /// Aggregates may not be added to a bulk retrieve attributes containing a field.
1687
1633
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1688
1634
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1689
1635
  /// \see BtrieveStatusCodeToString
@@ -1739,8 +1685,9 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkDeleteAttributesFree(btrieve_bul
1739
1685
  /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
1740
1686
  /// \param[in] maximumRecordCount The maximum record count.
1741
1687
  /// \par \DESCRIPTION
1742
- /// Maximum record count defaults to zero.
1688
+ /// Maximum record count defaults to BTRIEVE_MAXIMUM_BULK_RECORD_COUNT.
1743
1689
  /// Aggregates do not honor the maximum record count.
1690
+ /// \note The maximum record count default changed from zero to BTRIEVE_MAXIMUM_BULK_RECORD_COUNT in Zen v16 R1.
1744
1691
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1745
1692
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1746
1693
  /// \see BtrieveStatusCodeToString
@@ -1750,7 +1697,8 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkRetrieveAttributesSetMaximumReco
1750
1697
  /// \param[in] bulkDeleteAttributes The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
1751
1698
  /// \param[in] maximumRecordCount The maximum record count.
1752
1699
  /// \par \DESCRIPTION
1753
- /// Maximum record count defaults to zero.
1700
+ /// Maximum record count defaults to BTRIEVE_MAXIMUM_BULK_RECORD_COUNT.
1701
+ /// \note The maximum record count default changed from zero to BTRIEVE_MAXIMUM_BULK_RECORD_COUNT in Zen v16 R1.
1754
1702
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1755
1703
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1756
1704
  /// \see BtrieveStatusCodeToString
@@ -1761,7 +1709,7 @@ extern LINKAGE btrieve_status_code_t BtrieveBulkDeleteAttributesSetMaximumRecord
1761
1709
  /// \param[in] maximumRejectCount The maximum reject count.
1762
1710
  /// \par \DESCRIPTION
1763
1711
  /// Maximum reject count defaults to the Zen defined value.
1764
- /// Similarities and aggregates do not honor the maximum reject count.
1712
+ /// Aggregates do not honor the maximum reject count.
1765
1713
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
1766
1714
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
1767
1715
  /// \see BtrieveStatusCodeToString
@@ -2317,6 +2265,8 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkRetrieveNext(btrieve_file_t
2317
2265
  /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
2318
2266
  /// \param[out] bulkRetrieveResult The bulk retrieve result. See BtrieveBulkRetrieveResultAllocate().
2319
2267
  /// \param[in] lockMode The lock mode.
2268
+ /// \par \DESCRIPTION
2269
+ /// Comparison doesn't support ::BTRIEVE_COMPARISON_JSON_QUERY_MATCH, ::BTRIEVE_COMPARISON_LIKE, ::BTRIEVE_COMPARISON_NONE, ::BTRIEVE_COMPARISON_NOT_EQUAL or ::BTRIEVE_COMPARISON_NOT_LIKE. See BtrieveFilterSetComparison() for additional comparison support.
2320
2270
  /// \par \CURSOR
2321
2271
  /// The cursor is established.
2322
2272
  /// \par \CURRENT_OFFSET
@@ -2349,6 +2299,8 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkRetrievePrevious(btrieve_fil
2349
2299
  /// \param[in] bulkRetrieveAttributes The bulk retrieve attributes. See BtrieveBulkRetrieveAttributesAllocate().
2350
2300
  /// \param[out] bulkRetrieveResult The bulk retrieve result. See BtrieveBulkRetrieveResultAllocate().
2351
2301
  /// \param[in] lockMode The lock mode.
2302
+ /// \par \DESCRIPTION
2303
+ /// Comparison doesn't support ::BTRIEVE_COMPARISON_JSON_QUERY_MATCH, ::BTRIEVE_COMPARISON_LIKE, ::BTRIEVE_COMPARISON_NONE, ::BTRIEVE_COMPARISON_NOT_EQUAL or ::BTRIEVE_COMPARISON_NOT_LIKE. See BtrieveFilterSetComparison() for additional comparison support.
2352
2304
  /// \par \CURSOR
2353
2305
  /// The cursor is established.
2354
2306
  /// \par \CURRENT_OFFSET
@@ -2409,6 +2361,8 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkDeleteNext(btrieve_file_t fi
2409
2361
  /// \param[in] keyLength The key length.
2410
2362
  /// \param[in] bulkDeleteAttributes The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
2411
2363
  /// \param[out] bulkDeleteResult The bulk delete result. See BtrieveBulkDeleteResultAllocate().
2364
+ /// \par \DESCRIPTION
2365
+ /// Comparison doesn't support ::BTRIEVE_COMPARISON_JSON_QUERY_MATCH, ::BTRIEVE_COMPARISON_LIKE, ::BTRIEVE_COMPARISON_NONE, ::BTRIEVE_COMPARISON_NOT_EQUAL or ::BTRIEVE_COMPARISON_NOT_LIKE. See BtrieveFilterSetComparison() for additional comparison support.
2412
2366
  /// \par \CURSOR
2413
2367
  /// The cursor is established.
2414
2368
  /// \par \CURRENT_OFFSET
@@ -2439,6 +2393,8 @@ extern LINKAGE btrieve_status_code_t BtrieveFileBulkDeletePrevious(btrieve_file_
2439
2393
  /// \param[in] keyLength The key length.
2440
2394
  /// \param[in] bulkDeleteAttributes The bulk delete attributes. See BtrieveBulkDeleteAttributesAllocate().
2441
2395
  /// \param[out] bulkDeleteResult The bulk delete result. See BtrieveBulkDeleteResultAllocate().
2396
+ /// \par \DESCRIPTION
2397
+ /// Comparison doesn't support ::BTRIEVE_COMPARISON_JSON_QUERY_MATCH, ::BTRIEVE_COMPARISON_LIKE, ::BTRIEVE_COMPARISON_NONE, ::BTRIEVE_COMPARISON_NOT_EQUAL or ::BTRIEVE_COMPARISON_NOT_LIKE. See BtrieveFilterSetComparison() for additional comparison support.
2442
2398
  /// \par \CURSOR
2443
2399
  /// The cursor is established.
2444
2400
  /// \par \CURRENT_OFFSET
@@ -2648,6 +2604,8 @@ extern LINKAGE btrieve_status_code_t BtrieveFileInformationGetSegmentFileName(bt
2648
2604
  /// \param[in] index The index.
2649
2605
  /// \param[out] key The key.
2650
2606
  /// \param[in] keyLength The key length.
2607
+ /// \par \DESCRIPTION
2608
+ /// Comparison doesn't support ::BTRIEVE_COMPARISON_JSON_QUERY_MATCH, ::BTRIEVE_COMPARISON_LIKE, ::BTRIEVE_COMPARISON_NONE, ::BTRIEVE_COMPARISON_NOT_EQUAL or ::BTRIEVE_COMPARISON_NOT_LIKE. See BtrieveFilterSetComparison() for additional comparison support.
2651
2609
  /// \par \CURSOR
2652
2610
  /// The cursor is established.
2653
2611
  /// \par \CURRENT_OFFSET
@@ -2909,7 +2867,7 @@ extern LINKAGE btrieve_status_code_t BtrieveFilterSetACSUserDefined(btrieve_filt
2909
2867
  /// \param[in] filter The filter. See BtrieveFilterAllocate().
2910
2868
  /// \param[in] comparison The comparison.
2911
2869
  /// \par \DESCRIPTION
2912
- /// Comparison defaults to BTRIEVE_COMPARISON_NONE.
2870
+ /// Comparison defaults to ::BTRIEVE_COMPARISON_NONE.
2913
2871
  /// \retval "= BTRIEVE_STATUS_CODE_NO_ERROR" \SUCCESS
2914
2872
  /// \retval "!= BTRIEVE_STATUS_CODE_NO_ERROR" \ERROR_HAS_OCCURRED
2915
2873
  /// \see BtrieveStatusCodeToString
@@ -4068,6 +4026,8 @@ extern LINKAGE int BtrieveFileInformationGetWrongOwner(btrieve_file_information_
4068
4026
  /// \param[out] record The record.
4069
4027
  /// \param[in] recordSize The record size.
4070
4028
  /// \param[in] lockMode The lock mode.
4029
+ /// \par \DESCRIPTION
4030
+ /// Comparison doesn't support ::BTRIEVE_COMPARISON_JSON_QUERY_MATCH, ::BTRIEVE_COMPARISON_LIKE, ::BTRIEVE_COMPARISON_NONE, ::BTRIEVE_COMPARISON_NOT_EQUAL or ::BTRIEVE_COMPARISON_NOT_LIKE. See BtrieveFilterSetComparison() for additional comparison support.
4071
4031
  /// \par \SNIPPET
4072
4032
  /// \snippet btest.c FileRecordRetrieve
4073
4033
  /// \par \CURSOR