From f3dc4efd5f5997dfcad662dc43a2f60a6a628349 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 31 Oct 2000 11:04:29 -0500 Subject: [svn-r2760] Purpose: Removing functions that have been removed from library. Solution: Removed H5Pget_driver, H5P[gs]et_stdio, H5P[gs]et_sec2, H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family, H5P[gs]et_mpi, and H5P[gs]et_xfer. Platforms tested: IE5 --- doc/html/RM_H5P.html | 648 +++------------------------------------------------ 1 file changed, 27 insertions(+), 621 deletions(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index cfc8ddc..2b6e61a 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -88,25 +88,25 @@ many different parameters to be easily manipulated. File Access Properties @@ -154,8 +154,8 @@ many different parameters to be easily manipulated.
  • H5Pget_hyper_cache
  • H5Pset_btree_ratios
  • H5Pget_btree_ratios -
  • H5Pset_xfer   || -
  • H5Pget_xfer   || +
  • xxx   || +
  • xxx   || @@ -627,171 +627,6 @@ facilitate moving easily between them.
    -
    Name: H5Pset_mpi -
    Signature: -
    herr_t H5Pset_mpi(hid_t plist, - MPI_Comm comm, - MPI_Info info - ) -
    Purpose: -
    Retrieves the access mode for parallel I/O and the user supplied - communicator and info object. -
    Description: -
    H5Pset_mpi stores the access mode for MPIO call and the user supplied - communicator and info in the access property list, which can then - be used to open file. This function is available only in the - parallel HDF5 library and is not a collective function. -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of property list to modify. -
    MPI_Comm comm -
    IN: MPI communicator to be used for file open as defined in - MPI_FILE_OPEN of MPI-2. This function does not make a - duplicated comm. Any modification to comm after - this function call returns may have undetermined effect - to the access property list. Users should call this function - again to setup the property list. -
    MPI_Info info -
    IN: MPI info object to be used for file open as defined in - MPI_FILE_OPEN of MPI-2. This function does not make a - duplicated info. Any modification to info after - this function call returns may have undetermined effect - to the access property list. Users should call this function - again to setup the property list. -
    -
    Returns: -
    Returns a non-negative value if successful; - otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pget_mpi -
    Signature: -
    herr_t H5Pget_mpi(hid_t plist, - MPI_Comm *comm, - MPI_Info *info - ) -
    Purpose: -
    Retrieves the communicator and info object. -
    Description: -
    H5Pget_mpi retrieves the communicator and info object - that have been set by H5Pset_mpi. - This function is available only in the parallel HDF5 library - and is not a collective function. -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a file access property list that has been set - successfully by H5Pset_mpi. -
    MPI_Comm * comm -
    OUT: Pointer to location to return the communicator. -
    MPI_Info * info -
    OUT: Pointer to location to return the info object. -
    -
    Returns: -
    Returns a non-negative value if the file access property list is set to the MPI. - Otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pset_xfer -
    Signature: -
    herr_t H5Pset_xfer(hid_t plist, - H5D_transfer_t data_xfer_mode - ) -
    Purpose: -
    Sets the transfer mode of the dataset transfer property list. -
    Description: -
    H5Pset_xfer sets the transfer mode of the dataset transfer property list. - The list can then be used to control the I/O transfer mode - during dataset accesses. This function is available only - in the parallel HDF5 library and is not a collective function. -

    - Valid data transfer modes are: -

      -
      H5D_XFER_INDEPENDENT -
      Use independent I/O access. - (Currently the default mode.) -
      H5D_XFER_COLLECTIVE -
      Use MPI collective I/O access. -
      H5D_XFER_DFLT -
      User default I/O access. -
    -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a dataset transfer property list -
    H5D_transfer_t data_xfer_mode -
    IN: Data transfer mode. -
    -
    Returns: -
    Returns a non-negative value if successful; - otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pget_xfer -
    Signature: -
    herr_t H5Pget_xfer(hid_t plist, - H5D_transfer_t * data_xfer_mode - ) -
    Purpose: -
    Retrieves the transfer mode from the dataset transfer property list. -
    Description: -
    H5Pget_xfer retrieves the transfer mode from the - dataset transfer property list. - This function is available only in the parallel HDF5 library - and is not a collective function. -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a dataset transfer property list. -
    H5D_transfer_t * data_xfer_mode -
    OUT: Pointer to location to return the data transfer mode. -
    -
    Returns: -
    Returns a non-negative value if successful; - otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    Name: H5Pset_sym_k
    Signature:
    herr_t H5Pset_sym_k(hid_t plist, @@ -1657,355 +1492,29 @@ facilitate moving easily between them.
    -
    Name: H5Pget_driver -
    Signature: -
    H5F_driver_t H5Pget_driver(hid_t plist - ) -
    Purpose: -
    Returns a low-level file driver identifier. -
    Description: -
    H5Pget_driver returns the identifier of the - low-level file driver. Valid identifiers are: -
      -
    • H5F_LOW_STDIO (0) -
    • H5F_LOW_SEC2 (1) -
    • H5F_LOW_MPIO (2) -
    • H5F_LOW_CORE (3) -
    • H5F_LOW_SPLIT (4) -
    • H5F_LOW_FAMILY (5) -
    -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a file access property list. -
    -
    Returns: -
    Returns a low-level driver identifier if successful. - Otherwise returns H5F_LOW_ERROR (-1). -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pset_stdio -
    Signature: -
    herr_t H5Pset_stdio(hid_t plist) -
    Purpose: -
    Sets the low level file driver to use the functions declared - in the stdio.h. -
    Description: -
    H5Pset_stdio sets the low level file driver to use - the functions declared in the stdio.h file: fopen(), fseek() - or fseek64(), fread(), fwrite(), and fclose(). -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a file access property list. -
    -
    Returns: -
    Returns a non-negative value if successful; - otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pget_stdio -
    Signature: -
    herr_t H5Pget_stdio(hid_t plist) -
    Purpose: -
    Determines whether the file access property list is set to - the stdio driver. -
    Description: -
    H5Pget_stdio checks to determine whether the - file access property list is set to the stdio driver. - In the future, additional arguments may be added to this - function to match those added to H5Pset_stdio(). -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a file access property list. -
    -
    Returns: -
    Returns a non-negative value if the file access property list is set - to the stdio driver. - Otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pset_sec2 -
    Signature: -
    herr_t H5Pset_sec2(hid_t plist - ) -
    Purpose: -
    Sets the low-level file driver to use the declared functions. -
    Description: -
    H5Pset_sec2 sets the low-level file driver to use - the functions declared - in the unistd.h file: open(), lseek() or lseek64(), read(), - write(), and close(). -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a file access property list. -
    -
    Returns: -
    Returns a non-negative value if successful; - otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pget_sec2 -
    Signature: -
    herr_t H5Pget_sec2(hid_t plist) -
    Purpose: -
    Checks whether the file access property list is set - to the sec2 driver. -
    Description: -
    H5Pget_sec2 checks to determine whether the - file access property list is set to the sec2 driver. - In the future, additional arguments may be - added to this function to match those added to H5Pset_sec2(). -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a file access property list. -
    -
    Returns: -
    Returns a non-negative value if the file access property list is set - to the sec2 driver. - Otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pset_core -
    Signature: -
    herr_t H5Pset_core(hid_t plist, - size_t increment - ) -
    Purpose: -
    Sets the low-level file driver to use malloc() and free(). -
    Description: -
    H5Pset_core sets the low-level file driver to use - malloc() and free(). - This driver is restricted to temporary files which are not - larger than the amount of virtual memory available. - The increment argument determines the file block size - and memory will be allocated in multiples of increment bytes. - A liberal increment results in fewer calls to - realloc() and probably less memory fragmentation. -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of a file access property list. -
    size_t increment -
    IN: File block size in bytes. - Must be a positive value. -
    -
    Returns: -
    Returns a non-negative value if successful; - otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pget_core -
    Signature: -
    herr_t H5Pget_core(hid_t plist, - size_t *increment - ) -
    Purpose: -
    Determines whether the file access property list is set - to the core driver. -
    Description: -
    H5Pget_core checks to determine whether the - file access property list is set to the core driver. - On success, the block size is returned through the - increment if it is not the null pointer. - In the future, additional arguments may be added to this - function to match those added to H5Pset_core(). -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of the file access property list. -
    size_t *increment -
    OUT: Pointer to a location to return the file block size (in bytes). -
    -
    Returns: -
    Returns a non-negative value if the file access property list is set - to the core driver. - Otherwise returns a negative value. -
    Non-C API(s): -
    - -
    - - -
    -
    -
    Name: H5Pset_split +
    Name: xxx
    Signature: -
    herr_t H5Pset_split(hid_t plist, - const char *meta_ext, - hid_t meta_plist, - const char *raw_ext, - hid_t raw_plist +
    xxx xxx(xxx xxx )
    Purpose: -
    Sets the low-level driver to split meta data from raw data. +
    Description: -
    H5Pset_split sets the low-level driver to - split meta data from raw data, storing meta data in one file and - raw data in another file. The meta file will have a name - which is formed by adding meta_extension (recommended - default value: .meta) to the end of the base name - and will be accessed according to the meta_plist. - The raw file will have a name which is formed by appending - raw_extension (recommended default value: - .raw) to the base name and will be accessed according - to the raw_plist. - Additional parameters may be added to this function in the future. +
    xxx +
    Parameters:
    -
    hid_t plist -
    IN: Identifier of the file access property list. -
    const char *meta_ext -
    IN: Name of the extension for the metafile filename. - Recommended default value: .meta. -
    hid_t meta_plist -
    IN: Identifier of the meta file access property list. -
    const char *raw_ext -
    IN: Name extension for the raw file filename. - Recommended default value: .raw. -
    hid_t raw_plist -
    IN: Identifier of the raw file access property list. +
    xxx xxx +
    IN: +
    OUT:
    Returns: -
    Returns a non-negative value if successful; - otherwise returns a negative value. +
    Returns xxx if successful. + Otherwise returns xxx. + -
    - - -
    -
    -
    Name: H5Pget_split -
    Signature: -
    herr_t H5Pget_split(hid_t plist, - size_t meta_ext_size, - char *meta_ext, - hid_t *meta_plist, - size_t raw_ext_size, - char *raw_ext, - hid_t *raw_plist - ) -
    Purpose: -
    Determines whether the file access property list is set - to the split driver. -
    Description: -
    H5Pget_split checks to determine whether the file - access property list is set to the split driver. - On successful return, - meta_plist and raw_plist will - point to copies of the meta and raw access property lists - which should be closed by calling H5Pclose() when - the application is finished with them, but if the meta and/or - raw file has no property list then a negative value is - returned for that property list identifier. Also, if - meta_extension and/or raw_extension are - non-null pointers, at most meta_ext_size or - raw_ext_size characters of the meta or raw file name - extension will be copied to the specified buffer. If the - actual name is longer than what was requested then the result - will not be null terminated (similar to - strncpy()). In the future, additional arguments - may be added to this function to match those added to - H5Pset_split(). -
    Parameters: -
    -
    hid_t plist -
    IN: Identifier of the file access property list. -
    size_t meta_ext_size -
    IN: Number of characters of the meta file extension to be - copied to the meta_ext buffer. -
    char *meta_ext -
    OUT: Meta file extension. -
    hid_t *meta_plist -
    OUT: Pointer to a copy of the meta file access property list. -
    size_t raw_ext_size -
    IN: Number of characters of the raw file extension to be - copied to the raw_ext buffer. -
    char *raw_ext -
    OUT: Raw file extension. -
    hid_t *raw_plist -
    OUT: Pointer to a copy of the raw file access property list. -
    -
    Returns: -
    Returns a non-negative value if the file access property list is set - to the split driver. - Otherwise returns a negative value. -
    Non-C API(s): -
    - -
    Name: H5Pset_cache -- cgit v0.12