Share via

3.2.4.2.37.9 ValueDescriptions (put) (Opnum 19)

  • Article

The ValueDescriptions (put) method sets the Possible Value Definition.Description for the Possible Values of the property definition and returns S_OK upon successful completion.

 [propput, id(FSRM_PROPERTY(FSRM_DISPID_PROPERTY_DEFINITION | 0x04))] HRESULT ValueDescriptions(
   [in] SAFEARRAY(VARIANT) valueDescriptions
 );

valueDescriptions: Contains the array of Property Value Definition.Descriptions for the property definition.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

This code is returned for the following reasons:

  • The valueDescriptions parameter is not of type VT_BSTR.

  • The content of valueDescriptions exceeds the maximum length of 100 characters.

The server MUST iterate over the valueDescriptions list and the Possible Values list. For each entry (referred to as CurrentDescription and CurrentValue, respectively), set the Possible Value Definition.Description of CurrentValue to CurrentDescription, and advance to the next item in each list. Otherwise, the server MUST return a nonzero error code.