IFsrmPropertyDefinition::ValueDescriptions property

Descriptions for each of the possible values specified in the PossibleValues property.

This property is read/write.

Syntax


HRESULT put_ValueDescriptions(
  [in]   SAFEARRAY(VARIANT) possibleValues
);

HRESULT get_ValueDescriptions(
  [out]  SAFEARRAY(VARIANT) *pPossibleValues
);

Property value

A SAFEARRAY of VARIANTs that contains the descriptions of each of the possible values specified in the PossibleValues property. Set the variant type of each variant to VT_BSTR. Use the bstrVal member to specify the description of the possible value.

Each description is limited to 1,000 characters. If you do not want to specify descriptions, set to NULL or an empty array.

Error codes

The method returns the following return values.

NameMeaning
S_OK

Success

E_INVALIDARG

An attempt was made to set a possibleValues string that is too long, or the possibleValues parameter is not of type VT_BSTR.

Remarks

There is a one-to-one relationship between these descriptions and the list of possible values specified in the PossibleValues property. If you do not want to specify a description for one of the values in the list, set the corresponding item in the array to an empty string.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

DLL

SrmSvc.dll

IID

IID_IFsrmPropertyDefinition is defined as ede0150f-e9a3-419c-877c-01fe5d24c5d3

See also

IFsrmPropertyDefinition

 

 

Show:
© 2014 Microsoft. All rights reserved.