GPFS: Administration and Programming Reference - IRA Home

gpfs_get_fssnaphandle_by_fssnapid() Subroutine
Name
gpfs_get_fssnaphandle_by_fssnapid() - Obtains a GPFS file system snapshot handle given its
permanent, unique snapshot ID.
Library
GPFS Library (libgpfs.a for AIX, libgpfs.so for Linux)
Synopsis
#include
gpfs_fssnap_handle_t *gpfs_get_fssnaphandle_by_fssnapid
(const gpfs_fssnap_id_t *fssnapId);
Description
The gpfs_get_fssnaphandle_by_fssnapid() subroutine creates a handle for the file system or snapshot
that is uniquely identified by the permanent, unique snapshot ID.
Notes:
1. Compile any program that uses this subroutine with the -lgpfs flag from the following library:
v libgpfs.a for AIX
v libgpfs.so for Linux
Parameters
fssnapId File system snapshot ID
Exit status
If the gpfs_get_fssnaphandle_by_fssnapid() subroutine is successful, it returns a pointer to the file
system snapshot handle.
If the gpfs_get_fssnaphandle_by_fssnapid() subroutine is unsuccessful, it returns NULL and sets the
global error variable errno to indicate the nature of the error.
Exceptions
None.
Error status
ENOMEM Space could not be allocated for the file system snapshot handle.
ENOSYS The gpfs_get_fssnaphandle_by_fssnapid() subroutine is not available.
EPERM The caller does not have superuser privileges.
GPFS_E_INVAL_FSSNAPID
The file system snapshot ID is not valid.
Location
/usr/lpp/mmfs/lib/libgpfs.a for AIX, /usr/lpp/mmfs/lib/libgpfs.so for Linux
Chapter 9. GPFS programming interfaces 295