NeXusDataFormat  1
NeXusCAPI
 All Functions Groups
Functions
External linking
C API

Functions

NXstatus NXisexternalgroup (NXhandle handle, CONSTCHAR *name, CONSTCHAR *nxclass, char *url, int urlLen)
 Test if a group is actually pointing to an external file.
NXstatus NXisexternaldataset (NXhandle handle, CONSTCHAR *name, char *url, int urlLen)
 Test if a dataset is actually pointing to an external file.
NXstatus NXlinkexternal (NXhandle handle, CONSTCHAR *name, CONSTCHAR *nxclass, CONSTCHAR *url)
 Create a link to a group in an external file.
NXstatus NXlinkexternaldataset (NXhandle handle, CONSTCHAR *name, CONSTCHAR *url)
 Create a link to a dataset in an external file.

Detailed Description


Function Documentation

NXstatus NXisexternaldataset ( NXhandle  handle,
CONSTCHAR *  name,
char *  url,
int  urlLen 
)

Test if a dataset is actually pointing to an external file.

If so, retrieve the URL of the external file.

Parameters:
handleA NeXus file handle as initialized by NXopen.
nameThe name of the dataset to test.
urlA buffer to copy the URL too.
urlLenThe length of the Url buffer. At maximum urlLen bytes will be copied to url.
Returns:
NX_OK when the dataset is pointing to an external file, NX_ERROR else.
NXstatus NXisexternalgroup ( NXhandle  handle,
CONSTCHAR *  name,
CONSTCHAR *  nxclass,
char *  url,
int  urlLen 
)

Test if a group is actually pointing to an external file.

If so, retrieve the URL of the external file.

Parameters:
handleA NeXus file handle as initialized by NXopen.
nameThe name of the group to test.
nxclassThe class name of the group to test.
urlA buffer to copy the URL too.
urlLenThe length of the Url buffer. At maximum urlLen bytes will be copied to url.
Returns:
NX_OK when the group is pointing to an external file, NX_ERROR else.
NXstatus NXlinkexternal ( NXhandle  handle,
CONSTCHAR *  name,
CONSTCHAR *  nxclass,
CONSTCHAR *  url 
)

Create a link to a group in an external file.

This works by creating a NeXus group under the current level in the hierarchy which actually points to a group in another file.

Parameters:
handleA NeXus file handle as initialized by NXopen.
nameThe name of the group which points to the external file.
nxclassThe class name of the group which points to the external file.
urlThe URL of the external file. Currently only one URL format is supported: nxfile://path-tofile#path-in-file. This consists of two parts: the first part is of course the path to the file. The second part, path-in-file, is the path to the group in the external file which appears in the first file.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXlinkexternaldataset ( NXhandle  handle,
CONSTCHAR *  name,
CONSTCHAR *  url 
)

Create a link to a dataset in an external file.

This works by creating a dataset under the current level in the hierarchy which actually points to a dataset in another file.

Parameters:
handleA NeXus file handle as initialized by NXopen.
nameThe name of the dataset which points to the external file.
urlThe URL of the external file. Currently only one URL format is supported: nxfile://path-tofile#path-in-file. This consists of two parts: the first part is of course the path to the file. The second part, path-in-file, is the path to the dataset in the external file which appears in the first file.
Returns:
NX_OK on success, NX_ERROR in the case of an error.