1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
// ==========================================================
// FreeImage 3 .NET wrapper
// Original FreeImage 3 functions and .NET compatible derived functions
//
// Design and implementation by
// - Jean-Philippe Goerke (jpgoerke@users.sourceforge.net)
// - Carsten Klein (cklein05@users.sourceforge.net)
//
// Contributors:
// - David Boland (davidboland@vodafone.ie)
//
// Main reference : MSDN Knowlede Base
//
// This file is part of FreeImage 3
//
// COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTY
// OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
// THAT THE COVERED CODE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE
// OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED
// CODE IS WITH YOU. SHOULD ANY COVERED CODE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT
// THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
// SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL
// PART OF THIS LICENSE. NO USE OF ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER
// THIS DISCLAIMER.
//
// Use at your own risk!
// ==========================================================
// ==========================================================
// CVS
// $Revision: 1.5 $
// $Date: 2009/02/20 07:41:08 $
// $Id: FIMETADATA.cs,v 1.5 2009/02/20 07:41:08 cklein05 Exp $
// ==========================================================
using System;
using System.Runtime.InteropServices;
namespace FreeImageAPI
{
/// <summary>
/// The <b>FIMETADATA</b> structure is an unique search handle for metadata search operations.
/// </summary>
/// <remarks>
/// The <b>FIMETADATA</b> structure is usually returned by the
/// <see cref="FreeImageAPI.FreeImage.FindFirstMetadata(FREE_IMAGE_MDMODEL, FIBITMAP, out FITAG)"/>
/// function and then used on subsequent calls to
/// <see cref="FreeImageAPI.FreeImage.FindNextMetadata(FIMETADATA, out FITAG)"/>.
/// When the <b>FIMETADATA</b> handle is no longer used, it needs to be freed by the
/// <see cref="FreeImageAPI.FreeImage.FindCloseMetadata(FIMETADATA)"/> function.
/// </remarks>
[Serializable, StructLayout(LayoutKind.Sequential)]
public struct FIMETADATA : IComparable, IComparable<FIMETADATA>, IEquatable<FIMETADATA>
{
private IntPtr data;
/// <summary>
/// A read-only field that represents a handle that has been initialized to zero.
/// </summary>
public static readonly FIMETADATA Zero;
/// <summary>
/// Tests whether two specified <see cref="FIMETADATA"/> structures are equivalent.
/// </summary>
/// <param name="left">The <see cref="FIMETADATA"/> that is to the left of the equality operator.</param>
/// <param name="right">The <see cref="FIMETADATA"/> that is to the right of the equality operator.</param>
/// <returns>
/// <b>true</b> if the two <see cref="FIMETADATA"/> structures are equal; otherwise, <b>false</b>.
/// </returns>
public static bool operator ==(FIMETADATA left, FIMETADATA right)
{
return (left.data == right.data);
}
/// <summary>
/// Tests whether two specified <see cref="FIMETADATA"/> structures are different.
/// </summary>
/// <param name="left">The <see cref="FIMETADATA"/> that is to the left of the inequality operator.</param>
/// <param name="right">The <see cref="FIMETADATA"/> that is to the right of the inequality operator.</param>
/// <returns>
/// <b>true</b> if the two <see cref="FIMETADATA"/> structures are different; otherwise, <b>false</b>.
/// </returns>
public static bool operator !=(FIMETADATA left, FIMETADATA right)
{
return (left.data != right.data);
}
/// <summary>
/// Gets whether the pointer is a null pointer or not.
/// </summary>
/// <value><b>true</b> if this <see cref="FIMETADATA"/> is a null pointer;
/// otherwise, <b>false</b>.</value>
public bool IsNull
{
get
{
return (data == IntPtr.Zero);
}
}
/// <summary>
/// Sets the handle to <i>null</i>.
/// </summary>
public void SetNull()
{
data = IntPtr.Zero;
}
/// <summary>
/// Converts the numeric value of the <see cref="FIMETADATA"/> object
/// to its equivalent string representation.
/// </summary>
/// <returns>The string representation of the value of this instance.</returns>
public override string ToString()
{
return data.ToString();
}
/// <summary>
/// Returns a hash code for this <see cref="FIMETADATA"/> structure.
/// </summary>
/// <returns>An integer value that specifies the hash code for this <see cref="FIMETADATA"/>.</returns>
public override int GetHashCode()
{
return data.GetHashCode();
}
/// <summary>
/// Determines whether the specified <see cref="Object"/> is equal to the current <see cref="Object"/>.
/// </summary>
/// <param name="obj">The <see cref="Object"/> to compare with the current <see cref="Object"/>.</param>
/// <returns><b>true</b> if the specified <see cref="Object"/> is equal to the current <see cref="Object"/>; otherwise, <b>false</b>.</returns>
public override bool Equals(object obj)
{
return ((obj is FIMETADATA) && (this == ((FIMETADATA)obj)));
}
/// <summary>
/// Indicates whether the current object is equal to another object of the same type.
/// </summary>
/// <param name="other">An object to compare with this object.</param>
/// <returns><b>true</b> if the current object is equal to the other parameter; otherwise, <b>false</b>.</returns>
public bool Equals(FIMETADATA other)
{
return (this == other);
}
/// <summary>
/// Compares this instance with a specified <see cref="Object"/>.
/// </summary>
/// <param name="obj">An object to compare with this instance.</param>
/// <returns>A 32-bit signed integer indicating the lexical relationship between the two comparands.</returns>
/// <exception cref="ArgumentException"><paramref name="obj"/> is not a <see cref="FIMETADATA"/>.</exception>
public int CompareTo(object obj)
{
if (obj == null)
{
return 1;
}
if (!(obj is FIMETADATA))
{
throw new ArgumentException("obj");
}
return CompareTo((FIMETADATA)obj);
}
/// <summary>
/// Compares this instance with a specified <see cref="FIMETADATA"/> object.
/// </summary>
/// <param name="other">A <see cref="FIMETADATA"/> to compare.</param>
/// <returns>A signed number indicating the relative values of this instance
/// and <paramref name="other"/>.</returns>
public int CompareTo(FIMETADATA other)
{
return this.data.ToInt64().CompareTo(other.data.ToInt64());
}
}
}
|
