Bug #90615 Errors in reference documentation
Submitted: 24 Apr 2018 16:58 Modified: 15 Jun 2018 21:55
Reporter: JOSE RAMIREZ Email Updates:
Status: Closed Impact on me:
None 
Category:Connector / NET Severity:S3 (Non-critical)
Version:8.0.11 OS:Any
Assigned to: CPU Architecture:Any

[24 Apr 2018 16:58] JOSE RAMIREZ
Description:
When coding in C# using the X DevAPI there are some discrepancies with what's available through intellisense and what's documented in the reference documentation:

* Result.AffectedItemsCount, Result.WarningCount, SqlResult.ColumnCount, SqlResult.ColumnNames properties are missing.
* ArrayAppend, ArrayDelete and ArrayInsert methods are missing from the ModifyStatement class.

How to repeat:
Set up a C# project in Visual Studio and import the X DevAPI namespaces. Attempt to use any of the specified properties/methods.

Suggested fix:
Update reference documentation.
[25 Apr 2018 15:07] JOSE RAMIREZ
Posted by developer:
 
It's been identified that the the specified elements were documented early. These are notes regarding the affected items:

* Use the RecordsAffected property instead of AffectedItemsCount.
* Get the WarningCount/ColumnCount by getting the number of items in the Warnings/Columns collections.
* Get the ColumnNames property by extracting the name of each column in the Columns property.
* ArrayAppend, ArrayDelete, ArrayInsert would simply perform the self-explanatory operation on an array within a document. The same can be achieved by explicitly specifying the document path and index of the affected item within a document.