PropertyAsString

This method takes the property parameter and returns the value of the property it references as a string. This string is assigned to the value parameter. Providing an invalid property type, including an object or collection property, returns an empty string in the value parameter.

The GetPropertyFromMappings or GetPropertyFromObject methods must be called prior to calling PropertyAsString. The property parameter set by the GetPropertyFromMappings or GetPropertyFromObject methods should be passed as the property parameter to PropertyAsString.

Prototype

void PropertyAsString (VARIANT const property, BSTR* value)

Parameters

  • property - The property for which the value is to be retrieved.
  • value - The string representation of the property value.

Return Value

None (see the value parameter description for this function’s return value)