NeXusDataFormat  1
NeXusCAPI
 All Functions Groups
Functions
General File navigation
C API

Functions

NXstatus NXopenpath (NXhandle handle, CONSTCHAR *path)
 Open the NeXus object with the path specified.
NXstatus NXopengrouppath (NXhandle handle, CONSTCHAR *path)
 Opens the group in which the NeXus object with the specified path exists.
NXstatus NXgetpath (NXhandle handle, char *path, int pathlen)
 Retrieve the current path in the NeXus file.
NXstatus NXopensourcegroup (NXhandle handle)
 Open the source group of a linked group or dataset.
NXstatus NXgetnextentry (NXhandle handle, NXname name, NXname nxclass, int *datatype)
 Get the next entry in the currently open group.
NXstatus NXinitgroupdir (NXhandle handle)
 Resets a pending group search to the start again.
NXstatus NXinitattrdir (NXhandle handle)
 Resets a pending attribute search to the start again.

Detailed Description


Function Documentation

NXstatus NXgetnextentry ( NXhandle  handle,
NXname  name,
NXname  nxclass,
int *  datatype 
)

Get the next entry in the currently open group.

This is for retrieving infromation about the content of a NeXus group. In order to search a group NXgetnextentry is called in a loop until NXgetnextentry returns NX_EOD which indicates that there are no further items in the group. Reset search using NXinitgroupdir

Parameters:
handleA NeXus file handle as initialized by NXopen.
nameThe name of the object
nxclassThe NeXus class name for a group or the string SDS for a dataset.
datatypeThe NeXus data type if the item is a SDS.
Returns:
NX_OK on success, NX_ERROR in the case of an error, NX_EOD when there are no more items.
NXstatus NXgetpath ( NXhandle  handle,
char *  path,
int  pathlen 
)

Retrieve the current path in the NeXus file.

Parameters:
handlea NeXus file handle
pathA buffer to copy the path too
pathlenThe maximum number of characters to copy into path
Returns:
NX_OK or NX_ERROR
NXstatus NXinitattrdir ( NXhandle  handle)

Resets a pending attribute search to the start again.

To be called in a NXgetnextattr loop when an attribute search has to be restarted.

Parameters:
handleA NeXus file handle as initialized by NXopen.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXinitgroupdir ( NXhandle  handle)

Resets a pending group search to the start again.

To be called in a NXgetnextentry loop when a group search has to be restarted.

Parameters:
handleA NeXus file handle as initialized by NXopen.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXopengrouppath ( NXhandle  handle,
CONSTCHAR *  path 
)

Opens the group in which the NeXus object with the specified path exists.

Parameters:
handleA NeXus file handle as initialized by NXopen.
pathA unix like path string to a NeXus group or dataset. The path string is a list of group names and SDS names separated with / (slash). Example: /entry1/sample/name
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXopenpath ( NXhandle  handle,
CONSTCHAR *  path 
)

Open the NeXus object with the path specified.

Parameters:
handleA NeXus file handle as returned from NXopen.
pathA unix like path string to a NeXus group or dataset. The path string is a list of group names and SDS names separated with / (slash). Example: /entry1/sample/name
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXopensourcegroup ( NXhandle  handle)

Open the source group of a linked group or dataset.

Returns an error when the item is not a linked item.

Parameters:
handleA NeXus file handle as initialized by NXopen.
Returns:
NX_OK on success, NX_ERROR in the case of an error.