3.2.4.2.37.7 PossibleValues (put) (Opnum 17)

  • Article

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

 [propput, id(FSRM_PROPERTY(FSRM_DISPID_PROPERTY_DEFINITION | 0x03))] HRESULT PossibleValues(
   [in] SAFEARRAY(VARIANT) possibleValues
 );

possibleValues: Contains the array of Possible Value Definition.Names for the property definition.

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

Return value/code

Description

0x80045339

FSRM_E_OBJECT_IN_USE

A value that was removed from the list is in use.

0x80070057

E_INVALIDARG

This code is returned for the following reasons:

  • The possibleValues parameter is not of type VT_BSTR.

  • The content of the possibleValues parameter exceeds the maximum length of 100 characters.

The server MUST iterate over the possibleValues list and for each entry (referred to as CurrentName), if CurrentName is not the Possible Value Definition.Name of a member of Possible Values, create a new Possible Value Definition, set its Possible Value Definition.Name and Possible Value Definition.DisplayName to CurrentName, and add it to the Possible Values list, or return a nonzero error code.

The server MUST iterate over the Possible Values list and for each entry (referred to as CurrentValue), if the Possible Value Definition.Name of CurrentValue is not in possibleValues and not in use by at least one Rule, Report, or File Management Job when the call is made, remove CurrentValue from to the Possible Values list, or return a nonzero error code.