IInkExtendedProperties::Add

4/8/2010

Creates and adds an IInkExtendedProperty object to the IInkExtendedProperties collection.

Syntax

HRESULT Add (
  [in] BSTR Guid,
  [in] VARIANT data,
  [out, retval] IInkExtendedProperty **InkExtendedProperty
);

Parameters

• Guid
  Specifies the name of the new IInkExtendedProperty object. The name is expressed as a BSTR that represents the globally unique identifier (GUID) in the following format:

  {dfc71f44-354b-4ca1-93d7-7459410b6343} (Including curly braces)

  For more information about the BSTR data type, see Using the Automation Library with Windows Mobile Ink.

• Data
  Specifies the data for the new IInkExtendedProperty object.

  For more information about the VARIANT structure, see Using the Automation Library with Windows Mobile Ink.

• InkExtendedProperty
  Returns the new extended property.

Return Value

Remarks

You cannot store an empty IInkExtendedProperty object. The object must contain data before it can be stored. For example, if you try to add extended properties to a stroke for later use, an exception is thrown if the extended property contains no data.

The following types are acceptable:

• Byte or CHAR array
• Arrays of integers, floats, large integers, doubles, dates, or decimals
• Booleans (but not arrays of Booleans)
• BSTRs (but not arrays of BSTRs)
• Arrays of Variants. All arrays of variants passed as an IInkExtendedProperty must be of the same type and be all numeric. For example, variant arrays of BSTRS, arrays of arrays, VT_NULL and VT_EMPTY are not supported.

Requirements

See Also

Concepts

IInkStrokes
Windows Mobile Ink Reference