---

Last modified: May 2017

Name: H5PLget

Signature:

ssize_t H5PLget( unsigned int index, char *pathname, size_t size )

Purpose:

Query the plugin path at the specified index.

Description:

H5PLget queries the plugin path at a specified index. If pathname is non-NULL then it writes up to size bytes into that buffer and always returns the length of the pathname. Otherwise size is ignored and the function does not store the pathname, just returning the number of characters required to store the pathname. If an error occurs then the buffer pointed to by pathname (NULL or non-NULL) is unchanged and the function returns a negative value. If a zero is returned for the name's length, then there is no pathname associated with the index.

Parameters:

unsigned int  index	IN: Index.
char  *pathname	OUT: Pathname.
size_t  Size	IN: Size.

Returns:

Returns the length of the path, a non-negative value, if successful; otherwise returns a negative value.

History:

Release	C
1.10.1	Function introduced in this release.