From b527d73ddaf4d958045be784b48c309acb1a9fd7 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Mon, 13 Nov 2000 11:35:49 -0500 Subject: [svn-r2873] Purpose: Adding all functions new to Release 1.4. Solution: Adding first cut of all new API functions. H5Dvlen_get_buf_size H5Epush H5Pset_fapl_family H5Pget_fapl_family H5Pset_fapl_mpio H5Pget_fapl_mpio H5Pset_dxpl_mpio H5Pget_dxpl_mpio H5Pset_fapl_multi H5Pget_fapl_multi H5Pset_dxpl_multi H5Pget_dxpl_multi H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio H5Pset_fapl_stream H5Pget_fapl_stream H5Pset_fapl_log H5Pset_driver H5Pget_driver H5Pget_driver_info H5Pset_meta_block_size H5Pget_meta_block_size H5Pset_sieve_buf_size H5Pget_sieve_buf_size H5Pset_fapl_dpss H5Pset_fapl_gass H5Pget_fapl_gass H5Pset_fapl_srb H5Pget_fapl_srb H5Tarray_create H5Tget_array_ndims H5Tget_array_dims Platforms tested: IE 5. --- doc/html/RM_H5D.html | 21 +- doc/html/RM_H5E.html | 66 ++- doc/html/RM_H5P.html | 1486 +++++++++++++++++++++++++++++++++++++++++++++++++- doc/html/RM_H5T.html | 145 ++++- 4 files changed, 1678 insertions(+), 40 deletions(-) diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index c5c7b00..d543e95 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -67,7 +67,7 @@ and set and retrieve their constant or persistent properties.        @@ -111,7 +111,7 @@ facilitate moving easily between them.
  • h5dget_type_f
  • h5dget_create_plist_f - +        @@ -355,10 +355,9 @@ facilitate moving easily between them.
    -
    Name: H5Dget_vlen_buf_size -      (Not yet implemented.) +
    Name: H5Dvlen_get_buf_size
    Signature: -
    herr_t H5Dget_vlen_buf_size(hid_t dataset_id, +
    herr_t H5Dvlen_get_buf_size(hid_t dataset_id, hid_t type_id, hid_t space_id, hsize_t *size @@ -366,31 +365,31 @@ facilitate moving easily between them.
    Purpose:
    Determines the number of bytes required to store VL data.
    Description: -
    H5Dget_vlen_buf_size determines the number of bytes +
    H5Dvlen_get_buf_size determines the number of bytes required to store the VL data from the dataset, using the space_id for the selection in the dataset on disk and the type_id for the memory representation of the VL data in memory.

    - *size is returned with the number of bytes are + *size is returned with the number of bytes required to store the VL data in memory.

    Parameters:
    hid_t dataset_id
    Identifier of the dataset to query.
    hid_t type_id -
    Identifier of the datatype. +
    Datatype identifier.
    hid_t space_id -
    Identifier of the dataspace. +
    Dataspace identifier.
    hsize_t *size -
    The size in bytes of the buffer required to store the VL data. +
    The size in bytes of the memory buffer required to store the VL data.
    Returns:
    Returns non-negative value if successful; otherwise returns a negative value. + +
    + + +
    +
    Name: H5Eprint
    Signature:
    herr_t H5Eprint(FILE * stream) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 2b6e61a..1340b27 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -88,27 +88,47 @@ many different parameters to be easily manipulated. File Access Properties
      @@ -1424,8 +1444,7 @@ facilitate moving easily between them.
    Purpose:
    Returns information about a filter in a pipeline.
    Description: -
    - H5Pget_filter returns information about a +
    H5Pget_filter returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated.

    @@ -1492,29 +1511,177 @@ facilitate moving easily between them.

    -
    Name: xxx +
    Name: H5Pset_meta_block_size +
    Signature: +
    herr_t H5Pset_meta_block_size( + hid_t fapl_id, + hsize_t size + ) +
    Purpose: +
    Sets the minimum metadata block size. +
    Description: +
    H5Pset_meta_block_size sets the + minimum size, in bytes, of metadata block allocations when + H5FD_FEAT_AGGREGATE_METADATA is set by a VFL driver. +

    + Each raw metadata block is initially allocated to be of the + given size. Specific metadata objects (e.g., object headers, + local heaps, B-trees) are then sub-allocated from this block. +

    + The default setting is 2048 bytes, meaning that the library + will attempt to aggregate metadata in at least 2K blocks in the file. + Setting the value to 0 (zero) with this function + will turn off metadata aggregation, even if the VFL driver attempts + to use the metadata aggregation strategy. +

    + Metadata aggregation reduces the number of small data objects + in the file that would otherwise be required for metadata. + The aggregated block of metadata is usually written in a + single write action and always in a contiguous block, + potentially significantly improving library and application + performance. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    hsize_t size +
    IN: Minimum size, in bytes, of metadata block allocations. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_meta_block_size +
    Signature: +
    herr_t H5Pget_meta_block_size( + hid_t fapl_id, + hsize_t *size + ) +
    Purpose: +
    Returns the current metadata block size setting. +
    Description: +
    H5Pget_meta_block_size returns the current + minimum size, in bytes, of new metadata block allocations. + This setting is retrieved from the file access property list + fapl_id. +

    + This value is set by + H5Pset_meta_block_size + and is retrieved from the file access property list + fapl_id. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    hsize_t *size +
    OUT: Minimum size, in bytes, of metadata block allocations. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_sieve_buf_size
    Signature: -
    xxx xxx(xxx xxx +
    xxx H5Pset_sieve_buf_size( + hid_t fapl_id, + hsize_t size )
    Purpose:
    Description: -
    xxx +
    H5Pset_sieve_buf_size sets size, + the maximum size in bytes of the data seive buffer, which is + used by file drivers that are capable of using data sieving. +

    + The data sieve buffer is used when performing I/O on datasets in the file. Using a buffer which is large anough to hold several pieces of the dataset being read in for hyperslab selections boosts performance by quite a bit. +

    + The default value is set to 64KB, indicating that file I/O for raw data reads and writes will occur in at least 64KB blocks. Setting the value to 0 with this API function will turn off the data sieving, even if the VFL driver attempts to use that strategy. +

    + Need a conceptual understanding of data sieving to finish this. -- FB

    Parameters:
    -
    xxx xxx -
    IN: -
    OUT: +
    hid_t fapl_id +
    IN: File access property list identifier. +
    hsize_t size +
    IN: Maximum size, in bytes, of data sieve buffer.
    Returns: -
    Returns xxx if successful. - Otherwise returns xxx. +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + +
    + + +
    +
    +
    Name: H5Pget_sieve_buf_size +
    Signature: +
    herr_t H5Pget_sieve_buf_size( + hid_t fapl_id, + hsize_t *size + ) +
    +
    +
    Purpose: +
    Returns maximum data sieve buffer size. +
    Description: +
    H5Pget_sieve_buf_size retrieves, size, + the current maximum size of the data sieve buffer. +

    + This value is set by + H5Pset_sieve_buf_size + and is retrieved from the file access property list + fapl_id. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    hsize_t *size +
    IN: Maximum size, in bytes, of data sieve buffer. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + + + + +
    +
    +
    Name: H5Pset_fapl_family +
    Signature: +
    herr_t H5Pset_fapl_family ( + hid_t fapl_id, + hsize_t memb_size, + hid_t memb_fapl_id + ) +
    Purpose: +
    Sets the file access property list to use the family driver. +
    Description: +
    H5Pset_fapl_family sets the file access property list + identifier, fapl_id, to use the family driver. +

    + memb_size is the size in bytes of each file member + and is used only when creating a new file. +

    + memb_fapl_id is the identifier of the + file access property list to be used for each family member. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    hsize_t memb_size +
    IN: Size in bytes of each file member. +
    hid_t memb_fapl_id +
    IN: Identifier of file access property list for each + family member. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_fapl_family +
    Signature: +
    herr_t H5Pget_fapl_family ( + hid_t fapl_id, + hsize_t *memb_size, + hid_t *memb_fapl_id + ) +
    Purpose: +
    Returns file access property list information. +
    Description: +
    H5Pget_fapl_family returns file access property list + for use with the family driver. + This information is returned through the output parameters. +
    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    hsize_t *memb_size +
    OUT: Size in bytes of each file member. +
    hid_t *memb_fapl_id +
    OUT: Identifier of file access property list for each + family member. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_log +
    Signature: +
    herr_t H5Pset_fapl_log( + hid_t fapl_id, + char *logfile, + int verbosity + ) +
    Purpose: +
    Sets up the use of the logging driver. +
    Description: +
    H5Psget_fapl_log modifies the + file access property list to use the logging driver . + (H5FD_LOG ??) + There are no driver-specific properties. +

    + logfile is the name of the file in which the + logging entries are to be recorded. +

    + verbosity indicates the extent of the logging + activity intended, with a value of 0 indicating + no logging. + (Other values, range, ... ??) + +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    char *logfile +
    IN: Name of the log file. +
    int verbosity +
    IN: The extent of logging activity intended. +
    +
    Returns: +
    Returns non-negative if successful. + Otherwise returns negative. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_mpio +
    Signature: +
    herr_t H5Pset_fapl_mpio( + hid_t fapl_id, + MPI_Comm comm, + MPI_Info info + ) +
    Purpose: +
    Stores MPIO communicator information to the file access property list. +
    Description: +
    H5Pset_fapl_mpio stores the user supplied + MPIO communicator comm and info in + the file access property list fapl_id, + which can then be used to create and/or open the file. +

    + H5Pset_fapl_mpio is available only in the + parallel HDF5 library and is not a collective function. +

    + comm is the MPI communicator to be used for + file open as defined in MPI_FILE_OPEN of MPI-2. + This function does not create a duplicated communicator. + Modifications to comm after this function call + returns may have an undetermined effect on the access property list. + Users should not modify the communicator while it is defined + in a property list. +

    + info is the MPI info object to be used for + file open as defined in MPI_FILE_OPEN of MPI-2. + This function does not create a duplicated info object. + Any modification to the info object after this function call + returns may have an undetermined effect on the access property list. + Users should not modify the info while it is defined + in a property list. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    MPI_Comm comm +
    IN: MPI-2 communicator. +
    MPI_Info info +
    IN: MPI-2 info object. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_fapl_mpio +
    Signature: +
    herr_t H5Pget_fapl_mpio( + hid_t fapl_id, + MPI_Comm *comm, + MPI_Info *info + ) +
    Purpose: +
    Returns MPI communicator information. +
    Description: +
    If the file access property list is set to the H5FD_MPIO driver, + H5Pget_fapl_mpio returns the MPI communicator and + information through the comm and info + pointers, if those values are non-null. +

    + Neither comm nor info is copied, + so they are valid only until the file access property list + is either modified or closed. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    MPI_Comm *comm +
    OUT: MPI-2 communicator. +
    MPI_Info *info +
    OUT: MPI-2 info object. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_dxpl_mpio +
    Signature: +
    herr_t H5Pset_dxpl_mpio( + hid_t dxpl_id, + H5FD_mpio_xfer_t xfer_mode + ) +
    Purpose: +
    Sets data transfer mode. +
    Description: +
    H5Pset_dxpl_mpio sets the data transfer property list + dxpl_id to use transfer mode xfer_mode. + The property list can then be used to control the I/O transfer mode + during data I/O operations. +

    + Valid transfer modes are as follows: +

    +
    +
    H5FD_MPIO_INDEPENDENT +
    Use independent I/O access (default). +
    H5FD_MPIO_COLLECTIVE +
    Use collective I/O access. +
    +     +
    Parameters: +
    +
    hid_t dxpl_id +
    IN: Data transfer property list identifier. +
    H5FD_mpio_xfer_t xfer_mode +
    IN: Transfer mode. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_dxpl_mpio +
    Signature: +
    herr_t H5Pget_dxpl_mpio( + hid_t dxpl_id, + H5FD_mpio_xfer_t *xfer_mode + ) +
    Purpose: +
    Returns the data transfer mode. +
    Description: +
    H5Pget_dxpl_mpio queries the data transfer mode + currently set in the data transfer property list dxpl_id. +

    + Upon return, xfer_mode contains the data transfer mode, + if it is non-null. +

    + H5Pget_dxpl_mpio is not a collective function. +

    Parameters: +
    +
    hid_t dxpl_id +
    IN: Data transfer property list identifier. +
    H5FD_mpio_xfer_t *xfer_mode +
    OUT: Data transfer mode. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_multi +
    Signature: +
    herr_t H5Pset_fapl_multi( + hid_t fapl_id, + const H5FD_mem_t *memb_map, + const hid_t *memb_fapl, + const char **memb_name, + const haddr_t *memb_addr, + hbool_t relax + ) +
    Purpose: +
    Sets up use of the multi-file driver. +
    Description: +
    H5Pset_fapl_multi sets the file access property list + fapl_id to use the multi-file driver. +

    + The array memb_map maps memory usage types to other + memory usage types and is the mechanism that allows the caller + to specify how many files are created. + The array contains H5FD_MEM_NTYPES entries, + which are either the value H5FD_MEM_DEFAULT + or a memory usage type. + The number of unique values determines the number of files + that are opened. +

    + The array memb_fapl contains a property list + for each memory usage type that will be associated with a file. +

    + The array memb_name should be a name generator + (a printf-style format with a %s which will be replaced with the + name passed to H5FDopen(), usually from + H5Fcreate() or H5Fopen()). +

    + The array memb_addr .... +

    + If relax is set to TRUE (or 1), + then opening an existing file for read-only access will not fail + if some file members are missing. + This allows a file to be accessed in a limited sense if just the + meta data is available. +

    + Default values for each of the optional arguments are as follows: +

    +
    +
    memb_map +
    The default member map contains the value + H5FD_MEM_DEFAULT for each element. +
    memb_fapl +
    The default value is H5P_DEFAULT for each element. +
    memb_name +
    The default string is   %s-X.h5   + where   X   is one of the + following letters: + + s for H5FD_MEM_SUPER +
    + b for H5FD_MEM_BTREE +
    + r for H5FD_MEM_DRAW +
    + g for H5FD_MEM_GHEAP +
    + l for H5FD_MEM_LHEAP +
    + o for H5FD_MEM_OHDR +     +
    memb_addr +
    The default value is HADDR_UNDEF for each element. +
    +     +
    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    const H5FD_mem_t *memb_map +
    IN: Maps memory usage types to other memory usage types. +
    const hid_t *memb_fapl +
    IN: Property list for each memory usage type. +
    const char **memb_name +
    IN: Name generator for names of member files. +
    const haddr_t *memb_addr +
    IN: +
    hbool_t relax +
    IN: Allows read-only access to incomplete file sets + when TRUE. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. +
    Example: +
    The following code sample sets up a multi-file access property list + that partitions data into meta and raw files, each being + one-half of the address: + 
    +                  H5FD_mem_t mt, memb_map[H5FD_MEM_NTYPES];
+                  hid_t memb_fapl[H5FD_MEM_NTYPES];
+                  const char *memb[H5FD_MEM_NTYPES];
+                  haddr_t memb_addr[H5FD_MEM_NTYPES];
+ 
+                  // The mapping...
+                  for (mt=0; mt<H5FD_MEM_NTYPES; mt++) {
+                     memb_map[mt] = H5FD_MEM_SUPER;
+                  }
+                  memb_map[H5FD_MEM_DRAW] = H5FD_MEM_DRAW;
+ 
+                  // Member information
+                  memb_fapl[H5FD_MEM_SUPER] = H5P_DEFAULT;
+                  memb_name[H5FD_MEM_SUPER] = "%s.meta";
+                  memb_addr[H5FD_MEM_SUPER] = 0;
+ 
+                  memb_fapl[H5FD_MEM_DRAW] = H5P_DEFAULT;
+                  memb_name[H5FD_MEM_DRAW] = "%s.raw";
+                  memb_addr[H5FD_MEM_DRAW] = HADDR_MAX/2;
+ 
+                  hid_t fapl = H5Pcreate(H5P_FILE_ACCESS);
+                  H5Pset_fapl_multi(fapl, memb_map, memb_fapl,
+                                  memb_name, memb_addr, TRUE);
+
    + + +
    + + +
    +
    +
    Name: H5Pget_fapl_multi +
    Signature: +
    herr_t H5Pget_fapl_multi( + hid_t fapl_id, + const H5FD_mem_t *memb_map, + const hid_t *memb_fapl, + const char **memb_name, + const haddr_t *memb_addr, + hbool_t *relax + ) +
    Purpose: +
    Returns information about the multi-file access property list. +
    Description: +
    H5Pget_fapl_multi returns information about the + multi-file access property list. +
    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    const H5FD_mem_t *memb_map +
    OUT: Maps memory usage types to other memory usage types. +
    const hid_t *memb_fapl +
    OUT: Property list for each memory usage type. +
    const char **memb_name +
    OUT: Name generator for names of member files. +
    const haddr_t *memb_addr +
    OUT: +
    hbool_t *relax +
    OUT: Allows read-only access to incomplete file sets + when TRUE. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_dxpl_multi +
    Signature: +
    herr_t H5Pset_dxpl_multi( + hid_t dxpl_id, + const hid_t *memb_dxpl + ) +
    Purpose: +
    Sets the data transfer property list for the multi-file driver. +
    Description: +
    H5Pset_dxpl_multi sets the data transfer property list + dxpl_id to use the multi-file driver for each + memory usage type memb_dxpl[] + (after the usage map is applied). +
    Parameters: +
    +
    hid_t dxpl_id, +
    IN: Data transfer property list identifier. +
    const hid_t *memb_dxpl +
    IN: Array of memory usage types for ... +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_dxpl_multi +
    Signature: +
    herr_t H5Pget_dxpl_multi( + hid_t dxpl_id, + const hid_t *memb_dxpl + ) +
    +
    +
    Purpose: +
    Returns multi-file data transfer property list information. +
    Description: +
    H5Pget_dxpl_multi returns the data transfer property list + information for the multi-file driver. +
    Parameters: +
    +
    hid_t dxpl_id, +
    IN: Data transfer property list identifier. +
    const hid_t *memb_dxpl +
    OUT: Array of memory usage types for ... +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_split +
    Signature: +
    herr_t H5Pset_fapl_split( + hid_t fapl_id, + const char *meta_ext, + hid_t meta_plist_id, + const char *raw_ext, + hid_t raw_plist_id + ) +
    Purpose: +
    Emulates the old split file driver. +
    Description: +
    H5Pset_fapl_split is a compatability function that + enables the multi-file driver to emulate the split driver from + HDF5 Releases 1.0 and 1.2. +

    + fapl_id is .... +

    + meta_ext is .... +

    + meta_plist_id is the file property list identifier for + the meta data file. +

    + raw_ext is .... +

    + raw_plist_id is the file property list identifier for + the raw data file. +

    Parameters: +
    +
    +
    hid_t fapl_id, +
    IN: +
    const char *meta_ext, +
    IN: +
    hid_t meta_plist_id, +
    IN: +
    const char *raw_ext, +
    IN: +
    hid_t raw_plist_id +
    IN: +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_sec2 +
    Signature: +
    herr_t H5Psget_fapl_sec2( + hid_t fapl_id + ) +
    Purpose: +
    Sets the sec2 driver. +
    Description: +
    H5Psget_fapl_sec2 modifies the file access property list + to use the H5FD_SEC2 driver. +
    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_stdio +
    Signature: +
    herr_t H5Psget_fapl_stdio( + hid_t fapl_id + ) +
    Purpose: +
    Sets the standard I/O driver. +
    Description: +
    H5Psget_fapl_stdio modifies the file access property list + to use the standard I/O driver, H5FD_STDIO. +
    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_stream +
    Signature: +
    herr_t H5Pset_fapl_stream( + hid_t fapl_id, + H5FD_stream_fapl_t *fapl + ) +
    Purpose: +
    Sets up the use of the streaming I/O driver. +
    Description: +
    H5Pset_fapl_stream sets up the use of the + streaming I/O driver. +

    + fapl_id is the identifier for the + file access property list currently in use. +

    + fapl is ... +

    + The H5FD_stream_fapl_t struct contains the following + elements: +

    + + + + + + + + + + + + + + + + + + + +
    size_tincrement
    H5FD_STREAM_SOCKET_TYPEsocket
    hbool_tdo_socket_io
    unsigned intbacklog
    H5FD_stream_broadcast_tbroadcast_fn
    void *broadcast_arg
    +
      +
    • increment specifies how much memory to allocate + each time additional memory is required. +
    • socket is an external socket descriptor; + if a valid socket argument is provided, that socket will be used. +
    • do_socket_io is a boolean value specifying whether + to perform I/O on socket. +
    • backlog is the argument for the + listen call. +
    • broadcast_fn is the broadcast callback function. +
    • broadcast_arg is the user argument to + the broadcast callback function. +
    +     +

    + H5Pset_fapl_stream and H5Pget_fapl_stream + are not intended for use in a parallel environment. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    H5FD_stream_fapl_t *fapl +
    IN: The streaming I/O file access property list. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_fapl_stream +
    Signature: +
    herr_t H5Pget_fapl_stream( + hid_t fapl_id, + H5FD_stream_fapl_t *fapl + ) +
    Purpose: +
    Returns the streaming I/O driver settings. +
    Description: +
    H5Pget_fapl_stream returns the file access properties + set for the use of the streaming I/O driver. +

    + H5Pset_fapl_stream and H5Pget_fapl_stream + are not intended for use in a parallel environment. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    H5FD_stream_fapl_t *fapl +
    OUT: The streaming I/O file access property list. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_driver +
    Signature: +
    herr_t H5Pset_driver( + hid_t plist_id, + hid_t driver_id, + const void * driver_info + ) +
    Purpose: +
    Sets the file driver. +
    Description: +
    H5Pset_driver sets the file driver, + driver_id, for a file access or data transfer + property list, plist_id, and supplies an + optional struct containing the driver-specific properites, + driver_info. +

    + Need driver_info struct definition. +

    + The driver properties will be copied into the property list + and the reference count on the driver will be incremented, + allowing the caller to close the driver identifier but still use + the property list. +

    Parameters: +
    +
    hid_t plist_id +
    IN: File access or data transfer property list identifier. +
    hid_t driver_id +
    IN: Driver indentifier. +
    const void * driver_info +
    IN: Optional struct containing driver properties. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_driver +
    Signature: +
    hid_t H5Pget_driver( + hid_t plist_id + ) +
    Purpose: +
    Returns low-lever driver identifier. +
    Description: +
    H5Pget_driver returns the identifier of the + low-level file driver associated with the file access property list + or data transfer propert list plist_id. +

    + The returned driver identifier is only valid as long as the + file driver remains registered. +

    Parameters: +
    +
    hid_t plist_id +
    IN: File access or data transfer property list identifier. +
    +
    Returns: +
    Returns a vaild low-level driver identifier if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_driver_info +
    Signature: +
    void *H5Pget_driver_info( + hid_t plist_id + ) +
    Purpose: +
    Returns a pointer to file driver information. +
    Description: +
    H5Pget_driver_info returns a pointer to + file driver-specific information for the low-level driver + associated with the file access or data transfer property list + plist_id. + +

    + Need more on "a pointer" or on what + is "pointed to." Might this be the driver_info + struct definition in H5Pset_driver? + +

    + If no driver-specific properties have been registered, + H5Pget_driver_info returns NULL. +

    Parameters: +
    +
    hid_t plist_id +
    IN: File access or data transfer property list identifier. +
    +
    Returns: +
    Returns a pointer to the struct containing + low-level driver information. + Otherwise returns NULL. +

    + NULL is also returned if no driver-specific properties + have been registered. + No error is pushed on the stack in this case. + + +

    + + +
    +
    +
    Name: H5Pset_fapl_gass +
    Signature: +
    herr_t H5Psget_fapl_gass( + hid_t fapl_id, + GASS_Info info + ) +
    Purpose: +
    Stores user-supplied GASS information. +
    Description: +
    H5Psget_fapl_gass stores user-supplied GASS information, + the GASS_Info struct data as passed in info, + to the file access property list fapl_id. + fapl_id can then be used to create and/or open the file. +

    + The GASS_Info object, info, is used for + file open operations when using GASS in the Globus environment. +

    + Any modification to info after this function call + returns may have undetermined effect to the access property list. + Users must call H5Psget_fapl_gass again to setup + the property list. +

    Note: +
    H5Psget_fapl_gass is an experimental function. + It is designed for use only when accessing files via the + GASS facility of the Globus environment. + URL ?? +
    Parameters: +
    +
    hid_t fapl_id, +
    IN: File access property list identifier. +
    GASS_Info info +
    IN: Pointer to the GASS information structure. + +

    + Need GASS_Info struct. + +

    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_fapl_gass +
    Signature: +
    herr_t H5Pget_fapl_gass( + hid_t fapl_id, + GASS_Info *info + ) +
    Purpose: +
    Retrieves GASS information. +
    Description: +
    If the file access property list fapl_id is set + for use of the H5FD_GASS driver, + H5Pget_fapl_gass returns the GASS_Info + object through the info pointer. +

    + The GASS_Info information is copied, so it is valid + only until the file access property list is modified or closed. +

    Note: +
    H5Pget_fapl_gass is an experimental function. + It is designed for use only when accessing files via the + GASS facility of the Globus environment. + URL ?? +
    Parameters: +
    +
    hid_t fapl_id, +
    IN: File access property list identifier. +
    GASS_Info *info +
    OUT: Pointer to the GASS information structure. + +

    + Need GASS_Info struct. + +

    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_dpss +
    Signature: +
    herr_t H5Pset_fapl_dpss( + hid_t fapl_id + ) +
    Purpose: +
    Sets use of the DPSS I/O driver. +
    Description: +
    H5Pset_fapl_dpss modifies the file access property list + fapl_id to use the DPSS I/O driver in a + Globus evnvironment. +
    Note: +
    H5Pget_fapl_dpss is an experimental function. + It is designed for use only when accessing files via the + DPSS facility of the Globus environment. + URL ?? +

    + As of HDF5 Release 1.4 Beta, the Globus project has deprecated + the DPSS facility in favor of an FTP-based facility, which is still + under development. + While the DPSS functionality is still available, + it may be unavailable in future Globus releases. +

    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_fapl_srb +
    Signature: +
    herr_t H5Pset_fapl_srb( + hid_t fapl_id, + SRB_Info info + ) +
    Purpose: +
    Saves SRB connection handler and sets SRB settings. +
    Description: +
    H5Pset_fapl_srb stores the SRB client-to-server + connection handler SRB_CONN after the connection + is established and other user-supplied SRB information. +

    + The user-supplied SRB information is contained in the + SRB_Info struct pointed to by info + and is stored in the file access property list fapl_id. + This information can then be used to create or open a file. +

    Note: +
    H5Pset_fapl_gass is an experimental function. + It is designed for use only when accessing files via the + GASS facility of the Storage Resource Broker (SRB). + URL ?? +
    Parameters: +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    SRB_Info info +
    IN: Pointer to the SRB information structure. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + + + +
    +
    +
    Name: H5Pget_fapl_srb +
    Signature: +
    herr_t H5Pget_fapl_srb( + hid_t fapl_id, + SRB_Info *info + ) +
    Purpose: +
    Retrieves SRB information. +
    Description: +
    If the file access property list fapl_id is set + for use of the H5FD_SRB driver, + H5Pget_fapl_srb returns the SRB_Info + object through the info pointer. +

    + The SRB_Info information is copied, so it is valid + only until the file access property list is modified or closed. +

    Note: +
    H5Pset_fapl_gass is an experimental function. + It is designed for use only when accessing files via the + GASS facility of the Storage Resource Broker (SRB). + URL ?? +
    Parameters: +
    +
    +
    hid_t fapl_id +
    IN: File access property list identifier. +
    SRB_Info *info +
    OUT: Pointer to the SRB information structure. +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Psget_fapl_xxx +
    Signature: +
    xxx H5Psget_fapl_xxx( + xxx xxx, + xxx xxx, + xxx xxx + ) +
    Purpose: +
    +
    Description: +
    H5Psget_fapl_xxx + +
    Parameters: +
    +
    xxx xxx +
    IN: +
    OUT: +
    +
    Returns: +
    Returns a non-negative value if successful. + Otherwise returns a negative value. + + +
    + + + + +
    +
    +
    Name: xxx +
    Signature: +
    xxx xxx( + xxx xxx, + xxx xxx, + xxx xxx + ) +
    Purpose: +
    +
    Description: +
    xxx + +
    Parameters: +
    +
    xxx xxx +
    IN: +
    OUT: +
    +
    Returns: +
    Returns xxx if successful. + Otherwise returns xxx. + + +
    + +
    @@ -2417,7 +3855,7 @@ H5P   HDF Help Desk
    -Last modified: 13 July 2000 +Last modified: 1 November 2000
    Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.) diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 4a26179..45d224c 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -91,11 +91,11 @@ of a dataset.
  • H5Tset_pad
  • H5Tget_sign
  • H5Tset_sign +
  • H5Tget_fields
  • H5Tset_fields
  • H5Tget_ebias
  • H5Tset_ebias -
  • H5Tget_norm
  • H5Tset_norm
  • H5Tget_inpad @@ -108,6 +108,11 @@ of a dataset.

    Variable-length Datatypes

  • H5Tvlen_create +

    +Array Datatypes +

  • H5Tarray_create +
  • H5Tget_array_ndims +
  • H5Tget_array_dims
    		•        Compound Datatype Properties
  • H5Tget_nmembers @@ -200,6 +205,11 @@ facilitate moving easily between them.
  • h5tset_strpad_f + + + +
    		•        @@ -2582,6 +2592,139 @@ zero.
    +
    Name: H5Tarray_create +
    Signature: +
    hid_t *H5Tarray_create( + hid_t base, + int rank, + const hsize_t dims[/*rank*/], + const int perm[/*rank*/] + ) +
    Purpose: +
    Creates an array datatype object. +
    Description: +
    H5Tarray_create creates a new array datatype object. +

    + base is the datatype of every element of the array, + i.e., of the number at each position in the array. +

    + rank is the number of dimensions and the + size of each dimension is specified in the array dims. + The value of rank is currently limited to + H5S_MAX_RANK and must be greater than 0 + (zero). + All dimension sizes specified in dims must be greater + than 0 (zero). +

    + The array perm is designed to contain the dimension + permutation, i.e. C versus FORTRAN array order. +   + (The parameter perm is currently unused and is not yet implemented.) +

    +

    Parameters: +
    +
    hid_t base +
    IN: Datatype identifier for the array base datatype. +
    int rank +
    IN: Rank of the array. +
    const hsize_t dims[/*rank*/] +
    IN: Size of each array dimension. +
    const int perm[/*rank*/] +
    IN: Dimension permutation. +   + (Currently not implemented.) +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Tget_array_ndims +
    Signature: +
    int *H5Tget_array_ndims( + hid_t adtype_id + ) +
    Purpose: +
    Returns the rank of an array datatype. +
    Description: +
    H5Tget_array_ndims returns the rank, + the number of dimensions, of an array datatype object. +
    Parameters: +
    +
    hid_t adtype_id +
    IN: Datatype identifier of array object. +
    +
    Returns: +
    Returns the rank of the array if successful; + otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Tget_array_dims +
    Signature: +
    int *H5Tget_array_dims( + hid_t adtype_id, + hsize_t *dims[], + int *perm[] + ) +
    Purpose: +
    Returns sizes of array dimensions and dimension permutations. +
    Description: +
    H5Tget_array_dims returns the sizes of the dimensions + and the dimension permutations of the specified array datatype object. +

    + The sizes of the dimensions are returned in the array dims. + The dimension permutations, i.e., C versus FORTRAN array order, + are returned in the array perm. +

    Parameters: +
    +
    hid_t adtype_id +
    IN: Datatype identifier of array object. +
    hsize_t *dims[] +
    OUT: Sizes of array dimensions. +
    int *perm[] +
    OUT: Dimension permutations. +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. + + +
    + + +
    +
    Name: H5Tclose
    Signature:
    herr_t H5Tclose(hid_t type_id -- cgit v0.12