gpfs_get_pathname_from_fssnaphandle() subroutine

Obtains a file system path name using its snapshot handle.

Library

GPFS Library (libgpfs.a for AIX®, libgpfs.so for Linux®)

Synopsis

#include <gpfs.h>
const char *gpfs_get_pathname_from_fssnaphandle(gpfs_fssnap_handle_t *fssnapHandle);

Description

The gpfs_get_pathname_from_fssnaphandle() subroutine obtains the path name of the file system or snapshot identified by the open file system snapshot handle.

Note: Compile any program that uses this subroutine with the -lgpfs flag from the following library:

libgpfs.a for AIX
libgpfs.so for Linux

Parameters

fssnapHandle: File system snapshot handle.

Exit status

If the gpfs_get_pathname_from_fssnaphandle() subroutine is successful, it returns a pointer to the path name of the file system or snapshot.

If the gpfs_get_pathname_from_fssnaphandle() subroutine is unsuccessful, it returns NULL and sets the global error variable errno to indicate the nature of the error.

Exceptions

None.

Error status

Error codes include but are not limited to the following:

ENOSYS: The gpfs_get_pathname_from_fssnaphandle() subroutine is not available.
EPERM: The caller does not have superuser privileges.
GPFS_E_INVAL_FSSNAPHANDLE: The file system snapshot handle is not valid.

Examples

For an example using gpfs_get_pathname_from_fssnaphandle(), see /usr/lpp/mmfs/samples/util/tsfindinode.c.

Location

/usr/lpp/mmfs/lib/libgpfs.a for AIX

/usr/lpp/mmfs/lib/libgpfs.so for Linux