NeXusDataFormat  1
NeXusCAPI
 All Functions Groups
Functions
Linking
C API

Functions

NXstatus NXgetdataID (NXhandle handle, NXlink *pLink)
 Retrieve link data for a dataset.
NXstatus NXmakelink (NXhandle handle, NXlink *pLink)
 Create a link to the group or dataset described by pLink in the currently open group.
NXstatus NXmakenamedlink (NXhandle handle, CONSTCHAR *newname, NXlink *pLink)
 Create a link to the group or dataset described by pLink in the currently open group.
NXstatus NXgetgroupID (NXhandle handle, NXlink *pLink)
 Retrieve link data for the currently open group.
NXstatus NXsameID (NXhandle handle, NXlink *pFirstID, NXlink *pSecondID)
 Tests if two link data structures describe the same item.

Detailed Description


Function Documentation

NXstatus NXgetdataID ( NXhandle  handle,
NXlink *  pLink 
)

Retrieve link data for a dataset.

This link data can later on be used to link this dataset into a different group.

Parameters:
handleA NeXus file handle as initialized by NXopen.
pLinkA link data structure which will be initialized with the required information for linking.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXgetgroupID ( NXhandle  handle,
NXlink *  pLink 
)

Retrieve link data for the currently open group.

This link data can later on be used to link this group into a different group.

Parameters:
handleA NeXus file handle as initialized by NXopen.
pLinkA link data structure which will be initialized with the required information for linking.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXmakelink ( NXhandle  handle,
NXlink *  pLink 
)

Create a link to the group or dataset described by pLink in the currently open group.

Parameters:
handleA NeXus file handle as initialized by NXopen.
pLinkA link data structure describing the object to link. This must have been initialized by either a call to NXgetdataID or NXgetgroupID.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXmakenamedlink ( NXhandle  handle,
CONSTCHAR *  newname,
NXlink *  pLink 
)

Create a link to the group or dataset described by pLink in the currently open group.

But give the linked item a new name.

Parameters:
handleA NeXus file handle as initialized by NXopen.
newnameThe new name of the item in the currently open group.
pLinkA link data structure describing the object to link. This must have been initialized by either a call to NXgetdataID or NXgetgroupID.
Returns:
NX_OK on success, NX_ERROR in the case of an error.
NXstatus NXsameID ( NXhandle  handle,
NXlink *  pFirstID,
NXlink *  pSecondID 
)

Tests if two link data structures describe the same item.

Parameters:
handleA NeXus file handle as initialized by NXopen.
pFirstIDThe first link data for the test.
pSecondIDThe second link data structure.
Returns:
NX_OK when both link data structures describe the same item, NX_ERROR else.