//-----------------------------------------------------------------------
// <copyright file="jet_enumcolumnvalue.cs" company="Microsoft Corporation">
//     Copyright (c) Microsoft Corporation.
// </copyright>
//-----------------------------------------------------------------------

namespace Microsoft.Isam.Esent.Interop
{
    using System;
    using System.Diagnostics.CodeAnalysis;
    using System.Globalization;
    using System.Runtime.InteropServices;

    /// <summary>
    /// Native (unmanaged) version of the JET_ENUMCOLUMNVALUE class.
    /// </summary>
    [StructLayout(LayoutKind.Sequential)]
    [SuppressMessage("Microsoft.StyleCop.CSharp.NamingRules",
        "SA1305:FieldNamesMustNotUseHungarianNotation",
        Justification = "This should match the unmanaged API, which isn't capitalized.")]
    [SuppressMessage(
        "Microsoft.StyleCop.CSharp.NamingRules",
        "SA1307:AccessibleFieldsMustBeginWithUpperCaseLetter",
        Justification = "This should match the unmanaged API, which isn't capitalized.")]
    internal struct NATIVE_ENUMCOLUMNVALUE
    {
        /// <summary>
        /// The column value that was enumerated.
        /// </summary>
        public uint itagSequence;

        /// <summary>
        /// Error or warning from the enumeration.
        /// </summary>
        public int err;

        /// <summary>
        /// Size of returned data.
        /// </summary>
        public uint cbData;

        /// <summary>
        /// Pointer to returned data.
        /// </summary>
        public IntPtr pvData;
    }

    /// <summary>
    /// Enumerates the column values of a record using the JetEnumerateColumns
    /// function. <see cref="Api.JetEnumerateColumns(JET_SESID, JET_TABLEID, int, JET_ENUMCOLUMNID[], out int, out JET_ENUMCOLUMN[], JET_PFNREALLOC, IntPtr, int, EnumerateColumnsGrbit)"/>
    /// returns an array of JET_ENUMCOLUMNVALUE
    /// structures. The array is returned in memory that was allocated using
    /// the callback that was supplied to that function.
    /// </summary>
    [SuppressMessage(
        "Microsoft.StyleCop.CSharp.NamingRules",
        "SA1300:ElementMustBeginWithUpperCaseLetter",
        Justification = "This should match the unmanaged API, which isn't capitalized.")]
    [SuppressMessage("Microsoft.StyleCop.CSharp.NamingRules",
        "SA1305:FieldNamesMustNotUseHungarianNotation",
        Justification = "This should match the unmanaged API, which isn't capitalized.")]
    public class JET_ENUMCOLUMNVALUE
    {
        /// <summary>
        /// Gets the column value (by one-based index) that was enumerated.
        /// </summary>
        public int itagSequence { get; internal set; }

        /// <summary>
        /// Gets the column status code resulting from the enumeration of the
        /// column value.
        /// </summary>
        /// <seealso cref="JET_wrn.ColumnNull"/>
        /// <seealso cref="JET_wrn.ColumnSkipped"/>
        /// <seealso cref="JET_wrn.ColumnTruncated"/>
        public JET_wrn err { get; internal set; }

        /// <summary>
        /// Gets the size of the column value for the column.
        /// </summary>
        public int cbData { get; internal set; }

        /// <summary>
        /// Gets the value that was enumerated for the column.
        /// </summary>
        public IntPtr pvData { get; internal set; }

        /// <summary>
        /// Returns a <see cref="T:System.String"/> that represents the current <see cref="JET_ENUMCOLUMNVALUE"/>.
        /// </summary>
        /// <returns>
        /// A <see cref="T:System.String"/> that represents the current <see cref="JET_ENUMCOLUMNVALUE"/>.
        /// </returns>
        public override string ToString()
        {
            return string.Format(
                CultureInfo.InvariantCulture,
                "JET_ENUMCOLUMNVALUE(itagSequence = {0}, cbData = {1})",
                this.itagSequence,
                this.cbData);
        }

        /// <summary>
        /// Sets the fields of the object from a native JET_ENUMCOLUMN struct.
        /// </summary>
        /// <param name="value">
        /// The native enumcolumn to set the values from.
        /// </param>
        internal void SetFromNativeEnumColumnValue(NATIVE_ENUMCOLUMNVALUE value)
        {
            this.itagSequence = checked((int)value.itagSequence);
            this.err = (JET_wrn)value.err;
            this.cbData = checked((int)value.cbData);
            this.pvData = value.pvData;
        }
    }
}