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 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 boolpublic bool IsNumericScalar { get; }

    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 PropertyTypepublic PropertyType Type { get; }

    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 boolpublic bool GetBoolean()

    Returns

    • bool
      bool
      bool
      bool

      The value.

  • GetBooleanArray(Boolean[])
    GetBooleanArray(Boolean[])
    GetBooleanArray(Boolean[])
    GetBooleanArray(Boolean[])

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

    public void GetBooleanArray(Boolean[] value)public void GetBooleanArray(Boolean[] value)Public Function GetBooleanArray(value As Boolean[]) As voidpublic void GetBooleanArray(Boolean[] value)

    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 charpublic char GetChar16()

    Returns

    • char
      char
      char
      char

      The value.

  • GetChar16Array(Char[])
    GetChar16Array(Char[])
    GetChar16Array(Char[])
    GetChar16Array(Char[])

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

    public void GetChar16Array(Char[] value)public void GetChar16Array(Char[] value)Public Function GetChar16Array(value As Char[]) As voidpublic void GetChar16Array(Char[] value)

    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 DateTimeOffset GetDateTime()Public Function GetDateTime() As DateTimeOffsetpublic DateTime GetDateTime()

    Returns

  • GetDateTimeArray(DateTime[])
    GetDateTimeArray(DateTime[])
    GetDateTimeArray(DateTime[])
    GetDateTimeArray(DateTime[])

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

    public void GetDateTimeArray(DateTime[] value)public void GetDateTimeArray(DateTime[] value)Public Function GetDateTimeArray(value As DateTime[]) As voidpublic void GetDateTimeArray(DateTime[] value)

    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 doublepublic double GetDouble()

    Returns

    • double
      double
      double
      double

      The value.

  • GetDoubleArray(Double[])
    GetDoubleArray(Double[])
    GetDoubleArray(Double[])
    GetDoubleArray(Double[])

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

    public void GetDoubleArray(Double[] value)public void GetDoubleArray(Double[] value)Public Function GetDoubleArray(value As Double[]) As voidpublic void GetDoubleArray(Double[] value)

    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 Guidpublic Guid GetGuid()

    Returns

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

      The value.

  • GetGuidArray(Guid[])
    GetGuidArray(Guid[])
    GetGuidArray(Guid[])
    GetGuidArray(Guid[])

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

    public void GetGuidArray(Guid[] value)public void GetGuidArray(Guid[] value)Public Function GetGuidArray(value As Guid[]) As voidpublic void GetGuidArray(Guid[] value)

    Parameters

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

      The array of values.

  • GetInspectableArray(Object[])
    GetInspectableArray(Object[])
    GetInspectableArray(Object[])
    GetInspectableArray(Object[])

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

    public void GetInspectableArray(Object[] value)public void GetInspectableArray(Object[] value)Public Function GetInspectableArray(value As Object[]) As voidpublic void GetInspectableArray(Object[] value)

    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 shortpublic short GetInt16()

    Returns

    • short
      short
      short
      short

      The value.

  • GetInt16Array(Int16[])
    GetInt16Array(Int16[])
    GetInt16Array(Int16[])
    GetInt16Array(Int16[])

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

    public void GetInt16Array(Int16[] value)public void GetInt16Array(Int16[] value)Public Function GetInt16Array(value As Int16[]) As voidpublic void GetInt16Array(Int16[] value)

    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 intpublic int GetInt32()

    Returns

    • int
      int
      int
      int

      The value.

  • GetInt32Array(Int32[])
    GetInt32Array(Int32[])
    GetInt32Array(Int32[])
    GetInt32Array(Int32[])

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

    public void GetInt32Array(Int32[] value)public void GetInt32Array(Int32[] value)Public Function GetInt32Array(value As Int32[]) As voidpublic void GetInt32Array(Int32[] value)

    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 longpublic long GetInt64()

    Returns

    • long
      long
      long
      long

      The value.

  • GetInt64Array(Int64[])
    GetInt64Array(Int64[])
    GetInt64Array(Int64[])
    GetInt64Array(Int64[])

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

    public void GetInt64Array(Int64[] value)public void GetInt64Array(Int64[] value)Public Function GetInt64Array(value As Int64[]) As voidpublic void GetInt64Array(Int64[] value)

    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 Pointpublic Point GetPoint()

    Returns

  • GetPointArray(Point[])
    GetPointArray(Point[])
    GetPointArray(Point[])
    GetPointArray(Point[])

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

    public void GetPointArray(Point[] value)public void GetPointArray(Point[] value)Public Function GetPointArray(value As Point[]) As voidpublic void GetPointArray(Point[] value)

    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 Rectpublic Rect GetRect()

    Returns

  • GetRectArray(Rect[])
    GetRectArray(Rect[])
    GetRectArray(Rect[])
    GetRectArray(Rect[])

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

    public void GetRectArray(Rect[] value)public void GetRectArray(Rect[] value)Public Function GetRectArray(value As Rect[]) As voidpublic void GetRectArray(Rect[] value)

    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 floatpublic float GetSingle()

    Returns

    • float
      float
      float
      float

      The value.

  • GetSingleArray(Single[])
    GetSingleArray(Single[])
    GetSingleArray(Single[])
    GetSingleArray(Single[])

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

    public void GetSingleArray(Single[] value)public void GetSingleArray(Single[] value)Public Function GetSingleArray(value As Single[]) As voidpublic void GetSingleArray(Single[] value)

    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 Sizepublic Size GetSize()

    Returns

  • GetSizeArray(Size[])
    GetSizeArray(Size[])
    GetSizeArray(Size[])
    GetSizeArray(Size[])

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

    public void GetSizeArray(Size[] value)public void GetSizeArray(Size[] value)Public Function GetSizeArray(value As Size[]) As voidpublic void GetSizeArray(Size[] value)

    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 stringpublic string GetString()

    Returns

    • string
      string
      string
      string

      The value.

  • GetStringArray(String[])
    GetStringArray(String[])
    GetStringArray(String[])
    GetStringArray(String[])

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

    public void GetStringArray(String[] value)public void GetStringArray(String[] value)Public Function GetStringArray(value As String[]) As voidpublic void GetStringArray(String[] value)

    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 TimeSpanpublic TimeSpan GetTimeSpan()

    Returns

  • GetTimeSpanArray(TimeSpan[])
    GetTimeSpanArray(TimeSpan[])
    GetTimeSpanArray(TimeSpan[])
    GetTimeSpanArray(TimeSpan[])

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

    public void GetTimeSpanArray(TimeSpan[] value)public void GetTimeSpanArray(TimeSpan[] value)Public Function GetTimeSpanArray(value As TimeSpan[]) As voidpublic void GetTimeSpanArray(TimeSpan[] value)

    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 ushortpublic ushort GetUInt16()

    Returns

    • ushort
      ushort
      ushort
      ushort

      The value.

  • GetUInt16Array(UInt16[])
    GetUInt16Array(UInt16[])
    GetUInt16Array(UInt16[])
    GetUInt16Array(UInt16[])

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

    public void GetUInt16Array(UInt16[] value)public void GetUInt16Array(UInt16[] value)Public Function GetUInt16Array(value As UInt16[]) As voidpublic void GetUInt16Array(UInt16[] value)

    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 uintpublic uint GetUInt32()

    Returns

    • uint
      uint
      uint
      uint

      The value.

  • GetUInt32Array(UInt32[])
    GetUInt32Array(UInt32[])
    GetUInt32Array(UInt32[])
    GetUInt32Array(UInt32[])

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

    public void GetUInt32Array(UInt32[] value)public void GetUInt32Array(UInt32[] value)Public Function GetUInt32Array(value As UInt32[]) As voidpublic void GetUInt32Array(UInt32[] value)

    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 ulongpublic ulong GetUInt64()

    Returns

    • ulong
      ulong
      ulong
      ulong

      The value.

  • GetUInt64Array(UInt64[])
    GetUInt64Array(UInt64[])
    GetUInt64Array(UInt64[])
    GetUInt64Array(UInt64[])

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

    public void GetUInt64Array(UInt64[] value)public void GetUInt64Array(UInt64[] value)Public Function GetUInt64Array(value As UInt64[]) As voidpublic void GetUInt64Array(UInt64[] value)

    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 bytepublic byte GetUInt8()

    Returns

    • byte
      byte
      byte
      byte

      The value.

  • GetUInt8Array(Byte[])
    GetUInt8Array(Byte[])
    GetUInt8Array(Byte[])
    GetUInt8Array(Byte[])

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

    public void GetUInt8Array(Byte[] value)public void GetUInt8Array(Byte[] value)Public Function GetUInt8Array(value As Byte[]) As voidpublic void GetUInt8Array(Byte[] value)

    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