Show / Hide Table of Contents

    Class H5PL

    Inheritance
    System.Object
    H5PL
    Namespace: HDF.PInvoke
    Assembly: HDF.PInvoke.dll
    Syntax
    public sealed class H5PL : object

    Fields

    | Improve this Doc View Source

    ALL_PLUGIN

    Declaration
    public const int ALL_PLUGIN = null
    Field Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    FILTER_PLUGIN

    Declaration
    public const int FILTER_PLUGIN = null
    Field Value
    Type Description
    System.Int32

    Methods

    append(String)

    Append a plugin path to the plugin search path. See https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5PL.html#Plugin-Append

    Declaration
    public static System.Int32 append(string plugin_path)
    Parameters
    Type Name Description
    System.String plugin_path

    The plugin path

    Returns
    Type Description
    System.Int32

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

    get(System.UInt32, StringBuilder, IntPtr)

    Query the plugin path at the specified index. See https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5PL.html#Plugin-Get

    Declaration
    public static System.IntPtr get(System.UInt32 index, StringBuilder pathname, IntPtr size)
    Parameters
    Type Name Description
    System.UInt32 index

    Index

    StringBuilder pathname

    Path name

    IntPtr size

    Buffer size (in bytes)

    Returns
    Type Description
    System.IntPtr

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

    get_loading_state(ref Int32)

    Query state of the loading of dynamic plugins. See https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5PL.html#Plugin-GetLoadingState

    Declaration
    public static System.Int32 get_loading_state(ref int plugin_flags)
    Parameters
    Type Name Description
    System.Int32 plugin_flags

    List of dynamic plugin types that are enabled or disabled.

    Returns
    Type Description
    System.Int32

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

    insert(String, System.UInt32)

    Insert a plugin path at the specified index. See https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5PL.html#Plugin-Insert

    Declaration
    public static System.Int32 insert(string plugin_path, System.UInt32 index)
    Parameters
    Type Name Description
    System.String plugin_path

    The plugin path

    System.UInt32 index

    Index

    Returns
    Type Description
    System.Int32

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

    prepend(String)

    Insert a plugin path at the beginning of the list. See https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5PL.html#Plugin-Prepend

    Declaration
    public static System.Int32 prepend(string plugin_path)
    Parameters
    Type Name Description
    System.String plugin_path

    The plugin path

    Returns
    Type Description
    System.Int32

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

    remove(System.UInt32)

    Remove the plugin path at the specified index. See https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5PL.html#Plugin-Remove

    Declaration
    public static System.Int32 remove(System.UInt32 index)
    Parameters
    Type Name Description
    System.UInt32 index

    Index

    Returns
    Type Description
    System.Int32

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

    replace(String, System.UInt32)

    Replace the plugin path at the specified index. See https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5PL.html#Plugin-Replace

    Declaration
    public static System.Int32 replace(string plugin_path, System.UInt32 index)
    Parameters
    Type Name Description
    System.String plugin_path

    The plugin path

    System.UInt32 index

    Index

    Returns
    Type Description
    System.Int32

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

    set_loading_state(Int32)

    Control the loading of dynamic plugins. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5PL.html

    Declaration
    public static System.Int32 set_loading_state(int plugin_flags)
    Parameters
    Type Name Description
    System.Int32 plugin_flags

    The list of dynamic plugin types to enable or disable.

    Returns
    Type Description
    System.Int32

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

    size(ref System.UInt32)

    Query the size of the current list of plugin paths. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5PL.html

    Declaration
    public static System.Int32 size(ref System.UInt32 listsize)
    Parameters
    Type Name Description
    System.UInt32 listsize

    The size of the current list of plugin paths.

    Returns
    Type Description
    System.Int32

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

    • Improve this Doc
    • View Source
    Back to top Generated by DocFX