C# Class TagLib.IFD.IFDStructure

This class resembles the structure of a TIFF file. It can either be a top-level IFD, or a nested IFD (in the case of Exif).

Show file Open project: rubenv/tripod Class Usage Examples

Public Methods

Method	Description
AddEntry ( int directory, IFDEntry entry ) : void	Adds an IFDEntry to the IFD, if it is not already contained in, it fails otherwise.
ContainsTag ( int directory, ushort tag ) : bool	Checks, if a value for the given tag is contained in the IFD.
GetByteValue ( int directory, ushort entry_tag ) : byte?	Returns a System.Nullable containing the System.Byte stored in the entry defined by entry_tag.
GetDateTimeValue ( int directory, ushort entry_tag ) : DateTime?	Returns a System.Nullable containing the System.DateTime stored in the entry defined by entry_tag. The entry must be of type Entries.StringIFDEntry and contain an datestring according to the Exif specification.
GetEntry ( int directory, IFDEntryTag entry_tag ) : IFDEntry	Returns the IFDEntry belonging to the given tag.
GetEntry ( int directory, ushort tag ) : IFDEntry	Returns the IFDEntry belonging to the given tag.
GetLongValue ( int directory, ushort entry_tag ) : uint?	Returns a System.Nullable containing the System.UInt32 stored in the entry defined by entry_tag.
GetRationalValue ( int directory, ushort entry_tag ) : double?	Returns a System.Nullable containing the System.Double stored in the entry defined by entry_tag. The entry can be of type Entries.RationalIFDEntry or Entries.SRationalIFDEntry
GetStringValue ( int directory, ushort entry_tag ) : string	Returns the System.String stored in the entry defined by entry_tag.
RemoveTag ( int directory, IFDEntryTag entry_tag ) : void	Removes a given tag from the IFD.
RemoveTag ( int directory, ushort tag ) : void	Removes a given tag from the IFD.
SetByteValue ( int directory, ushort entry_tag, byte value ) : void	Adds a Entries.ByteIFDEntry to the directory with tag given by entry_tag and value given by value
SetDateTimeValue ( int directory, ushort entry_tag, System.DateTime value ) : void	Adds a Entries.StringIFDEntry to the directory with tag given by entry_tag and value given by value. The value is stored as a date string according to the Exif specification.
SetEntry ( int directory, IFDEntry entry ) : void	Adds an IFDEntry to the IFD. If it is already contained in the IFD, it is overwritten.
SetLongValue ( int directory, ushort entry_tag, uint value ) : void	Adds a Entries.LongIFDEntry to the directory with tag given by entry_tag and value given by value
SetRationalValue ( int directory, ushort entry_tag, double value ) : void	Adds a Entries.RationalIFDEntry to the directory with tag given by entry_tag and value given by value
SetStringValue ( int directory, ushort entry_tag, string value ) : void	Adds a Entries.StringIFDEntry to the directory with tag given by entry_tag and value given by value

Method Details

AddEntry() public method

Adds an IFDEntry to the IFD, if it is not already contained in, it fails otherwise.

public AddEntry ( int directory, IFDEntry entry ) : void
directory	int	/// A value with the directory index that /// should contain the tag that will be added. ///
entry	IFDEntry	/// A to add to the IFD. ///
return	void

ContainsTag() public method

Checks, if a value for the given tag is contained in the IFD.

public ContainsTag ( int directory, ushort tag ) : bool
directory	int	/// A value with the directory index that /// contains the tag. ///
tag	ushort	/// A value with the tag. ///
return	bool

GetByteValue() public method

Returns a System.Nullable containing the System.Byte stored in the entry defined by entry_tag.

public GetByteValue ( int directory, ushort entry_tag ) : byte?
directory	int	/// A with the number of the directory /// to search for the entry. ///
entry_tag	ushort	/// A with the tag of the entry ///
return	byte?

GetDateTimeValue() public method

Returns a System.Nullable containing the System.DateTime stored in the entry defined by entry_tag. The entry must be of type Entries.StringIFDEntry and contain an datestring according to the Exif specification.

public GetDateTimeValue ( int directory, ushort entry_tag ) : DateTime?
directory	int	/// A with the number of the directory /// to search for the entry. ///
entry_tag	ushort	/// A with the tag of the entry ///
return	DateTime?

GetEntry() public method

Returns the IFDEntry belonging to the given tag.

public GetEntry ( int directory, IFDEntryTag entry_tag ) : IFDEntry
directory	int	/// A with the directory that contains /// the wanted tag. ///
entry_tag	IFDEntryTag	/// A with the tag to get. ///
return	IFDEntry

GetEntry() public method

Returns the IFDEntry belonging to the given tag.

public GetEntry ( int directory, ushort tag ) : IFDEntry
directory	int	/// A with the directory that contains /// the wanted tag. ///
tag	ushort	/// A with the tag to get. ///
return	IFDEntry

GetLongValue() public method

Returns a System.Nullable containing the System.UInt32 stored in the entry defined by entry_tag.

public GetLongValue ( int directory, ushort entry_tag ) : uint?
directory	int	/// A with the number of the directory /// to search for the entry. ///
entry_tag	ushort	/// A with the tag of the entry ///
return	uint?

GetRationalValue() public method

Returns a System.Nullable containing the System.Double stored in the entry defined by entry_tag. The entry can be of type Entries.RationalIFDEntry or Entries.SRationalIFDEntry

public GetRationalValue ( int directory, ushort entry_tag ) : double?
directory	int	/// A with the number of the directory /// to search for the entry. ///
entry_tag	ushort	/// A with the tag of the entry ///
return	double?

GetStringValue() public method

Returns the System.String stored in the entry defined by entry_tag.

public GetStringValue ( int directory, ushort entry_tag ) : string
directory	int	/// A with the number of the directory /// to search for the entry. ///
entry_tag	ushort	/// A with the tag of the entry ///
return	string

RemoveTag() public method

Removes a given tag from the IFD.

public RemoveTag ( int directory, IFDEntryTag entry_tag ) : void
directory	int	/// A value with the directory index that /// contains the tag to remove. ///
entry_tag	IFDEntryTag	/// A value with the tag to remove. ///
return	void

RemoveTag() public method

Removes a given tag from the IFD.

public RemoveTag ( int directory, ushort tag ) : void
directory	int	/// A value with the directory index that /// contains the tag to remove. ///
tag	ushort	/// A value with the tag to remove. ///
return	void

SetByteValue() public method

Adds a Entries.ByteIFDEntry to the directory with tag given by entry_tag and value given by value

public SetByteValue ( int directory, ushort entry_tag, byte value ) : void
directory	int	/// A with the number of the directory /// to add the entry to. ///
entry_tag	ushort	/// A with the tag of the entry ///
value	byte	/// A with the value to add. ///
return	void

SetDateTimeValue() public method

Adds a Entries.StringIFDEntry to the directory with tag given by entry_tag and value given by value. The value is stored as a date string according to the Exif specification.

public SetDateTimeValue ( int directory, ushort entry_tag, System.DateTime value ) : void
directory	int	/// A with the number of the directory /// to add the entry to. ///
entry_tag	ushort	/// A with the tag of the entry ///
value	System.DateTime	/// A with the value to add. ///
return	void

SetEntry() public method

Adds an IFDEntry to the IFD. If it is already contained in the IFD, it is overwritten.

public SetEntry ( int directory, IFDEntry entry ) : void
directory	int	/// A value with the directory index that /// contains the tag that will be set. ///
entry	IFDEntry	/// A to add to the IFD. ///
return	void

SetLongValue() public method

Adds a Entries.LongIFDEntry to the directory with tag given by entry_tag and value given by value

public SetLongValue ( int directory, ushort entry_tag, uint value ) : void
directory	int	/// A with the number of the directory /// to add the entry to. ///
entry_tag	ushort	/// A with the tag of the entry ///
value	uint	/// A with the value to add. ///
return	void

SetRationalValue() public method

Adds a Entries.RationalIFDEntry to the directory with tag given by entry_tag and value given by value

public SetRationalValue ( int directory, ushort entry_tag, double value ) : void
directory	int	/// A with the number of the directory /// to add the entry to. ///
entry_tag	ushort	/// A with the tag of the entry ///
value	double	/// A with the value to add. It must be possible to /// represent the value by a . ///
return	void

SetStringValue() public method

Adds a Entries.StringIFDEntry to the directory with tag given by entry_tag and value given by value

public SetStringValue ( int directory, ushort entry_tag, string value ) : void
directory	int	/// A with the number of the directory /// to add the entry to. ///
entry_tag	ushort	/// A with the tag of the entry ///
value	string	/// A with the value to add. If it is /// an possibly already contained entry is removed for given tag. ///
return	void