[NeXus-code-tickets] [NeXusCode] #157: Possible problem in napi.h documentation

[NeXus Data Format Library and Applications]

#157: Possible problem in napi.h documentation
------------------------------+---------------------------------------------
  Reporter:  Stuart Campbell  |       Owner:  Paul Kienzle   
      Type:  defect           |      Status:  reopened       
  Priority:  minor            |   Milestone:  NeXus 4.2 Ready
 Component:  documentation    |     Version:  trunk          
Resolution:                   |    Keywords:  getgroupinfo   
------------------------------+---------------------------------------------
Changes (by Paul Kienzle):

  * keywords:  python => getgroupinfo
  * priority:  major => minor
  * component:  bindings => documentation
  * summary:  Possible problem in python openpath() => Possible problem in
              napi.h documentation

Comment:

 http://www.nexusformat.org/NAPI_Routines#NXgetgroupinfo

 Quoting:

     NXgetgroupinfo
     Returns the number of items in the current group, and the name and
 class of the current group.
     ...
     Output Arguments
       item_number        int *   Number of NeXus data items in the current
 group
       group_name         char *  Name of currently open NeXus group
       group_class        char *  Class of currently open NeXus group

 Looking in the source:

    HDF4: Vntagrefs returns the number of objects in a vgroup identified by
 the parameter vgroup_id.
    HDF5: iteratate over groups with group_info1: increments iNX if type is
 H5G_GROUP or H5G_DATASET
    XML: loop over child incrementing childCount

 And more importantly my code would fail if the getgroupinfo were returning
 the wrong thing.

 I'll leave this open until the doc issues are resolved, and rename it to a
 napi.h problem.

-- 
Ticket URL: <http://trac.nexusformat.org/code/ticket/157#comment:3>
NeXus Data Format Library and Applications <http://www.nexusformat.org/>
NeXus Data Format Library and Applications