Last modified: 8 May 2009
Name: H5Pget_elink_acc_flags
Signature:
  herr_t `H5Pget_elink_acc_flags`( hid_t `lapl_id`, unsigned *`flags` )

Purpose:
  Retrieves the external link traversal file access flag from the specified link access property list.

Description:
  `H5Pget_elink_acc_flags` retrieves the file access flag used to open an external link target file from the specified link access property list.

  The value returned, if it is not `H5F_ACC_DEFAULT` will override the default access flag, which is the access flag used to open the parent file.

Parameters:

  hid_t `lapl_id` |  | IN: Link access property list identifier
  unsigned *`flags` |  | OUT: File access flag for link traversal. Valid values include:
  | `H5F_ACC_RDWR` |  | Files opened through external links will be opened with write access.
  | `H5F_ACC_RDONLY` |  | Files opened through external links will be opened with read-only access.
  | `H5F_ACC_DEFAULT` |  | Files opened through external links will be opened with the same access flag as the parent file.

Returns:
  Returns a non-negative value if successful; otherwise returns a negative value.

Example Usage:
  The following code retrieves the external link access flag settings on the link access property list `lapl_id` into a local variable:

      unsigned acc_flags;
      status = H5Pget_elink_acc_flags(lapl_id, &acc_flags);

See Also:
  `H5Pset_elink_acc_flags`

History:

  Release | Change
  1.8.3 | C function introduced in this release.