Skip Navigation Links.

H5A..::..createByName Method (H5ObjectWithAttributes, , , H5DataTypeId, H5DataSpaceId, H5PropertyListId, H5PropertyListId, H5PropertyListId)

Creates an attribute attached to a specified object. http://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Create

Namespace:  HDF5DotNet
Assembly:  HDF5DotNet (in HDF5DotNet.dll)

Syntax

Visual Basic
Public Shared Function createByName ( _
	object As H5ObjectWithAttributes, _
	objectName As String, _
	attributeName As String, _
	typeId As H5DataTypeId, _
	spaceId As H5DataSpaceId, _
	attributeCreationProperties As H5PropertyListId, _
	attributePermissionsProperties As H5PropertyListId, _
	linkAccessProperties As H5PropertyListId _
) As H5AttributeId
C#
public static H5AttributeId createByName(
	H5ObjectWithAttributes object,
	string objectName,
	string attributeName,
	H5DataTypeId typeId,
	H5DataSpaceId spaceId,
	H5PropertyListId attributeCreationProperties,
	H5PropertyListId attributePermissionsProperties,
	H5PropertyListId linkAccessProperties
)
Visual C++
public:
static H5AttributeId^ createByName(
	H5ObjectWithAttributes^ object, 
	String^ objectName, 
	String^ attributeName, 
	H5DataTypeId^ typeId, 
	H5DataSpaceId^ spaceId, 
	H5PropertyListId^ attributeCreationProperties, 
	H5PropertyListId^ attributePermissionsProperties, 
	H5PropertyListId^ linkAccessProperties
)
JavaScript
HDF5DotNet.H5A.createByName = function(object, objectName, attributeName, typeId, spaceId, attributeCreationProperties, attributePermissionsProperties, linkAccessProperties);

Parameters

object
Type: HDF5DotNet..::..H5ObjectWithAttributes
IN: Location or object identifier; may be dataset or group
objectName
Type: String
IN: Name, relative to loc_id, of object that attribute is to be attached to
attributeName
Type: String
IN: Attribute name
typeId
Type: HDF5DotNet..::..H5DataTypeId
IN: Attribute datatype identifier
spaceId
Type: HDF5DotNet..::..H5DataSpaceId
IN: Attribute dataspace identifier
attributeCreationProperties
Type: HDF5DotNet..::..H5PropertyListId
IN: Attribute creation property list identifier -- Currently not used.
attributePermissionsProperties
Type: HDF5DotNet..::..H5PropertyListId
IN: Attribute access property list identifier -- Currently not used.
linkAccessProperties
Type: HDF5DotNet..::..H5PropertyListId
IN: Link access property list

Return Value

H5AttributeId associated with the created attribute.

Exceptions

ExceptionCondition
HDF5DotNet..::..H5AcreateByNameException throws H5AcreateByNameException on failure.

See Also