Changeset 1220 for trunk/include/napi.h

Timestamp:

17/03/09 11:06:04 (3 years ago)

Author:

Mark Koennecke

Message:

• Added a NXgetrawinfo function in the internal section. This function does not do any special processing for strings and rather returns the raw data size as read from file for strings. This is a special for Paul Kienzle. I marked this function as internal becuase for all normal cases, NXgetinfo as is does the right thing. Refs #173 We may even consider supressing documentation for NXgetrawinfo.

File:

• trunk/include/napi.h (modified) (2 diffs)

trunk/include/napi.h

@@ -199 +199 @@
 
 #    define NXgetinfo           MANGLE(nxigetinfo)
+#    define NXgetrawinfo        MANGLE(nxigetrawinfo)
 #    define NXgetnextentry      MANGLE(nxigetnextentry)
 #    define NXgetdata           MANGLE(nxigetdata)
@@ -684 +685 @@
     NAPI internals 
 ------------------------------------------------------------------------*/
+  /**
+   * Retrieve information about the currently open dataset. In contrast to the main function below, 
+   * this function does not try to find out about the size of strings properly. 
+   * \param handle A NeXus file handle as initialized by NXopen.
+   * \param rank A pointer to an integer which will be filled with the rank of 
+   * the dataset.
+   * \param dimension An array which will be initialized with the size of the dataset in any of its 
+   * dimensions. The array must have at least the size of rank.
+   * \param datatype A pointer to an integer which be set to the NeXus data type code for this dataset.
+   * \return NX_OK on success, NX_ERROR in the case of an error.   
+   * \ingroup c_metadata
+   */
+extern  NXstatus  NXgetrawinfo(NXhandle handle, int* rank, int dimension[], int* datatype);
+
 /** \typedef void (*ErrFunc)(void *data, char *text)
  * All NeXus error reporting happens through this special function, the