NeXusDataFormat  1
NeXusCAPI
 All Functions Groups
Functions
Meta data routines
C API

Functions

NXstatus NXgetinfo (NXhandle handle, int *rank, int dimension[], int *datatype)
 Retrieve information about the curretly open dataset.
NXstatus NXgetattrinfo (NXhandle handle, int *no_items)
 Get the count of attributes in the currently open dataset, group or global attributes when at root level.
NXstatus NXgetgroupinfo (NXhandle handle, int *no_items, NXname name, NXname nxclass)
 Retrieve information about the currently open group.
NXstatus NXinquirefile (NXhandle handle, char *filename, int filenameBufferLength)
 Inquire the filename of the currently open file.
const char * NXgetversion ()
 Utility function to return NeXus version.
NXstatus NXgetrawinfo (NXhandle handle, int *rank, int dimension[], int *datatype)
 Retrieve information about the currently open dataset.

Detailed Description


Function Documentation

NXstatus NXgetattrinfo ( NXhandle  handle,
int *  no_items 
)

Get the count of attributes in the currently open dataset, group or global attributes when at root level.

Parameters:
handleA NeXus file handle as initialized by NXopen.
no_itemsA pointer to an integer which be set to the number of attributes available.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXgetgroupinfo ( NXhandle  handle,
int *  no_items,
NXname  name,
NXname  nxclass 
)

Retrieve information about the currently open group.

Parameters:
handleA NeXus file handle as initialized by NXopen.
no_itemsA pointer to an integer which will be set to the count of group elements available. This is the count of other groups and data sets in this group.
nameThe name of the group.
nxclassThe NeXus class name of the group.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXgetinfo ( NXhandle  handle,
int *  rank,
int  dimension[],
int *  datatype 
)

Retrieve information about the curretly open dataset.

Parameters:
handleA NeXus file handle as initialized by NXopen.
rankA pointer to an integer which will be filled with the rank of the dataset.
dimensionAn 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.
datatypeA pointer to an integer which be set to the NeXus data type code for this dataset.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXgetrawinfo ( NXhandle  handle,
int *  rank,
int  dimension[],
int *  datatype 
)

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.

Parameters:
handleA NeXus file handle as initialized by NXopen.
rankA pointer to an integer which will be filled with the rank of the dataset.
dimensionAn 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.
datatypeA pointer to an integer which be set to the NeXus data type code for this dataset.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
const char* NXgetversion ( )

Utility function to return NeXus version.

Returns:
pointer to string in static storage. Version in same format as NEXUS_VERSION string in napi.h i.e. "major.minor.patch"
NXstatus NXinquirefile ( NXhandle  handle,
char *  filename,
int  filenameBufferLength 
)

Inquire the filename of the currently open file.

FilenameBufferLength of the file name will be copied into the filename buffer.

Parameters:
handleA NeXus file handle as initialized by NXopen.
filenameThe buffer to hold the filename.
filenameBufferLengthThe length of the filename buffer.
Returns:
NX_OK on success, NX_ERROR in the case of an error.