[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Create a HDF5 file

Syntax

Visual Basic (Declaration)
Public Shared Function create ( _
	filename As String, _
	mode As CreateMode _
) As H5FileId
C#
public static H5FileId create (
	string filename,
	H5F.CreateMode mode
)
C++
public:
static H5FileId^ create (
	String^ filename, 
	CreateMode mode
)

Parameters

filename (String)
filename for new HDF5 file
mode (CreateMode)
H5F.CreateMode enumeration type that specifies such modes as read-only (H5F.CreateMode.ACC_RDONLY)

Return Value

a vaild H5FileId for the created file

Remarks

Keeping the H5Id class implemented as an abstract data type provides us the opportunity for future source-compatible library upgrades.

Examples

[C#]

try
{
   // Create an HDF5 file.
   H5FileId fileId = H5F.create("myCSharp.h5", 
                                 H5F.CreateMode.ACC_TRUNC);
   H5F.close(openId);
}
catch (HDFException e)
{
   Console.WriteLine(e.Message);
}

[Visual Basic .NET]

Imports HDF5DotNet
Module Module1
 Sub Main()
     Dim FileId As H5FileId
        Try
            FileId = H5F.create("HDF5_fromVB", _
                                 H5F.CreateMode.ACC_TRUNC)
            H5F.close(FileId)
        Catch ex As HDFException
            Console.WriteLine(ex.Message())
        End Try
        Console.WriteLine("Processing complete!")
        Console.ReadLine()
    End Sub
End Module

[C++/Cli]

try
{
  // Create an HDF5 file.
  H5FileId^ fileId = H5F::create("myCpp.h5", 
	                         H5F::CreateMode::ACC_TRUNC);
  // Close the file
  H5F::close(fileId);
}
catch (HDFException^ e)
{
   Console::WriteLine(e->Message);
}

Exceptions

ExceptionCondition
throws H5CreateException when create fails