gpfs_get_fssnaphandle_by_fssnapid() subroutine

Obtains a file system snapshot handle using its snapshot ID.

Library

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

Synopsis

#include <gpfs.h>
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.

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

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

Error codes include but are not limited to the following:

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