H5StringAttributeSet Method (InArrayString, NullableStringEncoding, NullableInt32, NullableInt32, NullableStringPadding)

public void Set(
	InArray<string> A,
	Nullable<StringEncoding> encoding = null,
	Nullable<int> baseType = null,
	Nullable<int> length = null,
	Nullable<StringPadding> padding = null
)

Public Sub Set ( 
	A As InArray(Of String),
	Optional encoding As Nullable(Of StringEncoding) = Nothing,
	Optional baseType As Nullable(Of Integer) = Nothing,
	Optional length As Nullable(Of Integer) = Nothing,
	Optional padding As Nullable(Of StringPadding) = Nothing
)

Dim instance As H5StringAttribute
Dim A As InArray(Of String)
Dim encoding As Nullable(Of StringEncoding)
Dim baseType As Nullable(Of Integer)
Dim length As Nullable(Of Integer)
Dim padding As Nullable(Of StringPadding)

instance.Set(A, encoding, baseType, length, 
	padding)

Parameters

A

Type: ILNumericsInArrayString
New data for the attribute.

encoding (Optional)

Type: SystemNullableStringEncoding
[Optional] The encoding used to store the unicode characters in the file. Default: null (do not change).

baseType (Optional)

Type: SystemNullableInt32
[Optional] The base type used for storing the string elements in the file. Default: null (do not change).

length (Optional)

Type: SystemNullableInt32
[Optional] The length of individual elements. Default: null (do not change).

padding (Optional)

Type: SystemNullableStringPadding
[Optional] Padding character for remaining characters on fixed length strings. Default: null (do not change).

The value of A will replace the whole existing attribute data and the size of the attribute as well as any additional parameter is adjusted to match the size of A and the new settings. Internally, and since HDF5 does not allow the manipulation of parameters after creation the attribute is deleted and recreated with the new settings.

For variable length strings a setting of -1 for the length parameter is not considered a 'change'. Hence the new string values are stored in the same attribute object without having to recreate the attribute. This is true even if the length of the new values differ from any lengths already stored in the file.

A value of

null

[ILNumerics HDF5 Module]

Reference