IPropertyValue IPropertyValue IPropertyValue IPropertyValue Interface

Represents a value in a property store. You can't implement this interface, see Remarks.

Syntax

Declaration

public interface IPropertyValuepublic interface IPropertyValuePublic Interface IPropertyValue

Remarks

The IPropertyValue interface is a store for values whose type is not known until runtime.

To obtain the value stored in an IPropertyValue object, when the type of the stored property is not known ahead of time, you should first determine the stored type from the Type property and then call the appropriate IPropertyValue method for the type.

If the type is known ahead of time, you can the type access method of IPropertyValue interface directory and check for the return value to verify type returned was what is expected. If the type returned does not match the value of the Type property then the method fails with the TYPE_E_TYPEMISMATCH error.

You can't implement the IPropertyValue interface or include it in a signature. IPropertyValue is mainly an internal implementation detail of how the Windows Runtime implements boxing and nullable values.

Properties summary

Gets a value that indicates whether the property value is a scalar value.

Returns the type stored in the property value.

Methods summary

Returns the Boolean value stored as a property value.

Returns the array of Boolean values stored as a property value.

Returns the Unicode character stored as a property value.

Returns the array of Unicode characters stored as a property value.

Returns the date and time value stored as a property value.

Returns the array of date and time values stored as a property value.

Returns the floating-point value stored as a property value.

Returns the array of floating-point values stored as a property value.

Returns the GUID value stored as a property value.

Returns the array of GUID values stored as a property value.

Returns the array of inspectable objects stored as a property value.

Returns the integer value stored as a property value.

Returns the array of integer values stored as a property value.

Returns the integer value stored as a property value.

Returns the array of integer values stored as a property value.

Returns the integer value stored as a property value.

Returns the array of integer values stored as a property value.

Returns the point structure stored as a property value.

Returns the array of point structures stored as a property value.

Returns the rectangle structure stored as a property value.

Returns the array of rectangle structures stored as a property value.

Returns the floating-point value stored as a property value.

Returns the array of floating-point values stored as a property value.

Returns the size structure stored as a property value.

Returns the array of size structures stored as a property value.

Returns the string value stored as a property value.

Returns the array of string values stored as a property value.

Returns the time interval value stored as a property value.

Returns the array of time interval values stored as a property value.

Returns the unsigned integer value stored as a property value.

Returns the array of unsigned integer values stored as a property value.

Returns the unsigned integer value stored as a property value.

Returns the array of unsigned integer values stored as a property value.

Returns the unsigned integer value stored as a property value.

Returns the array of unsigned integer values stored as a property value.

Returns the byte value stored as a property value.

Returns the array of byte values stored as a property value.

Properties

  • IsNumericScalar
    IsNumericScalar
    IsNumericScalar
    IsNumericScalar

    Gets a value that indicates whether the property value is a scalar value.

    public bool IsNumericScalar { get; }public bool IsNumericScalar { get; }Public ReadOnly Property IsNumericScalar As bool

    Property Value

    • bool
      bool
      bool
      bool

      True if the value is scalar; otherwise false.

  • Type
    Type
    Type
    Type

    Returns the type stored in the property value.

    public PropertyType Type { get; }public PropertyType Type { get; }Public ReadOnly Property Type As PropertyType

    Property Value

Methods

  • GetBoolean()
    GetBoolean()
    GetBoolean()
    GetBoolean()

    Returns the Boolean value stored as a property value.

    public bool GetBoolean()public bool GetBoolean()Public Function GetBoolean() As bool

    Returns

    • bool
      bool
      bool
      bool

      The value.

  • GetBooleanArray(System.Boolean[])
    GetBooleanArray(System.Boolean[])
    GetBooleanArray(System.Boolean[])
    GetBooleanArray(System.Boolean[])

    Returns the array of Boolean values stored as a property value.

    public void GetBooleanArray(System.Boolean[])public void GetBooleanArray(System.Boolean[])Public Function GetBooleanArray(System.Boolean[]) As void

    Parameters

    • value
      System.Boolean[]
      System.Boolean[]
      System.Boolean[]
      System.Boolean[]

      The array of values.

  • GetChar16()
    GetChar16()
    GetChar16()
    GetChar16()

    Returns the Unicode character stored as a property value.

    public char GetChar16()public char GetChar16()Public Function GetChar16() As char

    Returns

    • char
      char
      char
      char

      The value.

  • GetChar16Array(System.Char[])
    GetChar16Array(System.Char[])
    GetChar16Array(System.Char[])
    GetChar16Array(System.Char[])

    Returns the array of Unicode characters stored as a property value.

    public void GetChar16Array(System.Char[])public void GetChar16Array(System.Char[])Public Function GetChar16Array(System.Char[]) As void

    Parameters

    • value
      System.Char[]
      System.Char[]
      System.Char[]
      System.Char[]

      The array of values.

  • GetDateTime()
    GetDateTime()
    GetDateTime()
    GetDateTime()

    Returns the date and time value stored as a property value.

    public DateTime GetDateTime()public DateTime GetDateTime()Public Function GetDateTime() As DateTime

    Returns

  • GetDateTimeArray(Windows.Foundation.DateTime[])
    GetDateTimeArray(Windows.Foundation.DateTime[])
    GetDateTimeArray(Windows.Foundation.DateTime[])
    GetDateTimeArray(Windows.Foundation.DateTime[])

    Returns the array of date and time values stored as a property value.

    public void GetDateTimeArray(Windows.Foundation.DateTime[])public void GetDateTimeArray(Windows.Foundation.DateTime[])Public Function GetDateTimeArray(Windows.Foundation.DateTime[]) As void

    Parameters

    • value
      Windows.Foundation.DateTime[]
      Windows.Foundation.DateTime[]
      Windows.Foundation.DateTime[]
      Windows.Foundation.DateTime[]

      The array of values.

  • GetDouble()
    GetDouble()
    GetDouble()
    GetDouble()

    Returns the floating-point value stored as a property value.

    public double GetDouble()public double GetDouble()Public Function GetDouble() As double

    Returns

    • double
      double
      double
      double

      The value.

  • GetDoubleArray(System.Double[])
    GetDoubleArray(System.Double[])
    GetDoubleArray(System.Double[])
    GetDoubleArray(System.Double[])

    Returns the array of floating-point values stored as a property value.

    public void GetDoubleArray(System.Double[])public void GetDoubleArray(System.Double[])Public Function GetDoubleArray(System.Double[]) As void

    Parameters

    • value
      System.Double[]
      System.Double[]
      System.Double[]
      System.Double[]

      The array of values.

  • GetGuid()
    GetGuid()
    GetGuid()
    GetGuid()

    Returns the GUID value stored as a property value.

    public Guid GetGuid()public Guid GetGuid()Public Function GetGuid() As Guid

    Returns

    • System.Guid
      System.Guid
      System.Guid
      System.Guid

      The value.

  • GetGuidArray(System.Guid[])
    GetGuidArray(System.Guid[])
    GetGuidArray(System.Guid[])
    GetGuidArray(System.Guid[])

    Returns the array of GUID values stored as a property value.

    public void GetGuidArray(System.Guid[])public void GetGuidArray(System.Guid[])Public Function GetGuidArray(System.Guid[]) As void

    Parameters

    • value
      System.Guid[]
      System.Guid[]
      System.Guid[]
      System.Guid[]

      The array of values.

  • GetInspectableArray(System.Object[])
    GetInspectableArray(System.Object[])
    GetInspectableArray(System.Object[])
    GetInspectableArray(System.Object[])

    Returns the array of inspectable objects stored as a property value.

    public void GetInspectableArray(System.Object[])public void GetInspectableArray(System.Object[])Public Function GetInspectableArray(System.Object[]) As void

    Parameters

    • value
      System.Object[]
      System.Object[]
      System.Object[]
      System.Object[]

      The array of objects.

  • GetInt16()
    GetInt16()
    GetInt16()
    GetInt16()

    Returns the integer value stored as a property value.

    public short GetInt16()public short GetInt16()Public Function GetInt16() As short

    Returns

    • short
      short
      short
      short

      The value.

  • GetInt16Array(System.Int16[])
    GetInt16Array(System.Int16[])
    GetInt16Array(System.Int16[])
    GetInt16Array(System.Int16[])

    Returns the array of integer values stored as a property value.

    public void GetInt16Array(System.Int16[])public void GetInt16Array(System.Int16[])Public Function GetInt16Array(System.Int16[]) As void

    Parameters

    • value
      System.Int16[]
      System.Int16[]
      System.Int16[]
      System.Int16[]

      The array of values.

  • GetInt32()
    GetInt32()
    GetInt32()
    GetInt32()

    Returns the integer value stored as a property value.

    public int GetInt32()public int GetInt32()Public Function GetInt32() As int

    Returns

    • int
      int
      int
      int

      The value.

  • GetInt32Array(System.Int32[])
    GetInt32Array(System.Int32[])
    GetInt32Array(System.Int32[])
    GetInt32Array(System.Int32[])

    Returns the array of integer values stored as a property value.

    public void GetInt32Array(System.Int32[])public void GetInt32Array(System.Int32[])Public Function GetInt32Array(System.Int32[]) As void

    Parameters

    • value
      System.Int32[]
      System.Int32[]
      System.Int32[]
      System.Int32[]

      The array of values.

  • GetInt64()
    GetInt64()
    GetInt64()
    GetInt64()

    Returns the integer value stored as a property value.

    public long GetInt64()public long GetInt64()Public Function GetInt64() As long

    Returns

    • long
      long
      long
      long

      The value.

  • GetInt64Array(System.Int64[])
    GetInt64Array(System.Int64[])
    GetInt64Array(System.Int64[])
    GetInt64Array(System.Int64[])

    Returns the array of integer values stored as a property value.

    public void GetInt64Array(System.Int64[])public void GetInt64Array(System.Int64[])Public Function GetInt64Array(System.Int64[]) As void

    Parameters

    • value
      System.Int64[]
      System.Int64[]
      System.Int64[]
      System.Int64[]

      The array of values.

  • GetPoint()
    GetPoint()
    GetPoint()
    GetPoint()

    Returns the point structure stored as a property value.

    public Point GetPoint()public Point GetPoint()Public Function GetPoint() As Point

    Returns

  • GetPointArray(Windows.Foundation.Point[])
    GetPointArray(Windows.Foundation.Point[])
    GetPointArray(Windows.Foundation.Point[])
    GetPointArray(Windows.Foundation.Point[])

    Returns the array of point structures stored as a property value.

    public void GetPointArray(Windows.Foundation.Point[])public void GetPointArray(Windows.Foundation.Point[])Public Function GetPointArray(Windows.Foundation.Point[]) As void

    Parameters

    • value
      Windows.Foundation.Point[]
      Windows.Foundation.Point[]
      Windows.Foundation.Point[]
      Windows.Foundation.Point[]

      The array of structures.

  • GetRect()
    GetRect()
    GetRect()
    GetRect()

    Returns the rectangle structure stored as a property value.

    public Rect GetRect()public Rect GetRect()Public Function GetRect() As Rect

    Returns

  • GetRectArray(Windows.Foundation.Rect[])
    GetRectArray(Windows.Foundation.Rect[])
    GetRectArray(Windows.Foundation.Rect[])
    GetRectArray(Windows.Foundation.Rect[])

    Returns the array of rectangle structures stored as a property value.

    public void GetRectArray(Windows.Foundation.Rect[])public void GetRectArray(Windows.Foundation.Rect[])Public Function GetRectArray(Windows.Foundation.Rect[]) As void

    Parameters

    • value
      Windows.Foundation.Rect[]
      Windows.Foundation.Rect[]
      Windows.Foundation.Rect[]
      Windows.Foundation.Rect[]

      The array of structures.

  • GetSingle()
    GetSingle()
    GetSingle()
    GetSingle()

    Returns the floating-point value stored as a property value.

    public float GetSingle()public float GetSingle()Public Function GetSingle() As float

    Returns

    • float
      float
      float
      float

      The value.

  • GetSingleArray(System.Single[])
    GetSingleArray(System.Single[])
    GetSingleArray(System.Single[])
    GetSingleArray(System.Single[])

    Returns the array of floating-point values stored as a property value.

    public void GetSingleArray(System.Single[])public void GetSingleArray(System.Single[])Public Function GetSingleArray(System.Single[]) As void

    Parameters

    • value
      System.Single[]
      System.Single[]
      System.Single[]
      System.Single[]

      The array of values.

  • GetSize()
    GetSize()
    GetSize()
    GetSize()

    Returns the size structure stored as a property value.

    public Size GetSize()public Size GetSize()Public Function GetSize() As Size

    Returns

  • GetSizeArray(Windows.Foundation.Size[])
    GetSizeArray(Windows.Foundation.Size[])
    GetSizeArray(Windows.Foundation.Size[])
    GetSizeArray(Windows.Foundation.Size[])

    Returns the array of size structures stored as a property value.

    public void GetSizeArray(Windows.Foundation.Size[])public void GetSizeArray(Windows.Foundation.Size[])Public Function GetSizeArray(Windows.Foundation.Size[]) As void

    Parameters

    • value
      Windows.Foundation.Size[]
      Windows.Foundation.Size[]
      Windows.Foundation.Size[]
      Windows.Foundation.Size[]

      The array of structures.

  • GetString()
    GetString()
    GetString()
    GetString()

    Returns the string value stored as a property value.

    public string GetString()public string GetString()Public Function GetString() As string

    Returns

    • string
      string
      string
      string

      The value.

  • GetStringArray(System.String[])
    GetStringArray(System.String[])
    GetStringArray(System.String[])
    GetStringArray(System.String[])

    Returns the array of string values stored as a property value.

    public void GetStringArray(System.String[])public void GetStringArray(System.String[])Public Function GetStringArray(System.String[]) As void

    Parameters

    • value
      System.String[]
      System.String[]
      System.String[]
      System.String[]

      The array of values.

  • GetTimeSpan()
    GetTimeSpan()
    GetTimeSpan()
    GetTimeSpan()

    Returns the time interval value stored as a property value.

    public TimeSpan GetTimeSpan()public TimeSpan GetTimeSpan()Public Function GetTimeSpan() As TimeSpan

    Returns

  • GetTimeSpanArray(Windows.Foundation.TimeSpan[])
    GetTimeSpanArray(Windows.Foundation.TimeSpan[])
    GetTimeSpanArray(Windows.Foundation.TimeSpan[])
    GetTimeSpanArray(Windows.Foundation.TimeSpan[])

    Returns the array of time interval values stored as a property value.

    public void GetTimeSpanArray(Windows.Foundation.TimeSpan[])public void GetTimeSpanArray(Windows.Foundation.TimeSpan[])Public Function GetTimeSpanArray(Windows.Foundation.TimeSpan[]) As void

    Parameters

    • value
      Windows.Foundation.TimeSpan[]
      Windows.Foundation.TimeSpan[]
      Windows.Foundation.TimeSpan[]
      Windows.Foundation.TimeSpan[]

      The array of values.

  • GetUInt16()
    GetUInt16()
    GetUInt16()
    GetUInt16()

    Returns the unsigned integer value stored as a property value.

    public ushort GetUInt16()public ushort GetUInt16()Public Function GetUInt16() As ushort

    Returns

    • ushort
      ushort
      ushort
      ushort

      The value.

  • GetUInt16Array(System.UInt16[])
    GetUInt16Array(System.UInt16[])
    GetUInt16Array(System.UInt16[])
    GetUInt16Array(System.UInt16[])

    Returns the array of unsigned integer values stored as a property value.

    public void GetUInt16Array(System.UInt16[])public void GetUInt16Array(System.UInt16[])Public Function GetUInt16Array(System.UInt16[]) As void

    Parameters

    • value
      System.UInt16[]
      System.UInt16[]
      System.UInt16[]
      System.UInt16[]

      The array of values.

  • GetUInt32()
    GetUInt32()
    GetUInt32()
    GetUInt32()

    Returns the unsigned integer value stored as a property value.

    public uint GetUInt32()public uint GetUInt32()Public Function GetUInt32() As uint

    Returns

    • uint
      uint
      uint
      uint

      The value.

  • GetUInt32Array(System.UInt32[])
    GetUInt32Array(System.UInt32[])
    GetUInt32Array(System.UInt32[])
    GetUInt32Array(System.UInt32[])

    Returns the array of unsigned integer values stored as a property value.

    public void GetUInt32Array(System.UInt32[])public void GetUInt32Array(System.UInt32[])Public Function GetUInt32Array(System.UInt32[]) As void

    Parameters

    • value
      System.UInt32[]
      System.UInt32[]
      System.UInt32[]
      System.UInt32[]

      The array of values.

  • GetUInt64()
    GetUInt64()
    GetUInt64()
    GetUInt64()

    Returns the unsigned integer value stored as a property value.

    public ulong GetUInt64()public ulong GetUInt64()Public Function GetUInt64() As ulong

    Returns

    • ulong
      ulong
      ulong
      ulong

      The value.

  • GetUInt64Array(System.UInt64[])
    GetUInt64Array(System.UInt64[])
    GetUInt64Array(System.UInt64[])
    GetUInt64Array(System.UInt64[])

    Returns the array of unsigned integer values stored as a property value.

    public void GetUInt64Array(System.UInt64[])public void GetUInt64Array(System.UInt64[])Public Function GetUInt64Array(System.UInt64[]) As void

    Parameters

    • value
      System.UInt64[]
      System.UInt64[]
      System.UInt64[]
      System.UInt64[]

      The array of values.

  • GetUInt8()
    GetUInt8()
    GetUInt8()
    GetUInt8()

    Returns the byte value stored as a property value.

    public byte GetUInt8()public byte GetUInt8()Public Function GetUInt8() As byte

    Returns

    • byte
      byte
      byte
      byte

      The value.

  • GetUInt8Array(System.Byte[])
    GetUInt8Array(System.Byte[])
    GetUInt8Array(System.Byte[])
    GetUInt8Array(System.Byte[])

    Returns the array of byte values stored as a property value.

    public void GetUInt8Array(System.Byte[])public void GetUInt8Array(System.Byte[])Public Function GetUInt8Array(System.Byte[]) As void

    Parameters

    • value
      System.Byte[]
      System.Byte[]
      System.Byte[]
      System.Byte[]

      The array of values.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.FoundationContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute

Details

Assembly

Windows.Foundation.dll