Share via

IsRestricted Property

  • Article

The IsRestricted property contains the flag that indicates whether a value for a property is restricted to one of the defined values in the dictionary list.

Syntax
Property IsRestricted As Boolean[C++]
Get method:
HRESULT get_IsRestricted(VARIANT_BOOL*pIsRestricted);
Put method:
HRESULT put_IsRestricted(VARIANT_BOOL varIsRestricted);

[Visual Basic]

Parameters

None

Return Values

This property returns a Boolean that contains the flag that indicates that property values are restricted.

Error Values

If an error is raised, Err.Number is set to one of the values documented on the Error Messages page.

[C++]

Parameters

Get method:

  • pIsRestricted
    [out, retval] Pointer to a VARIANT_BOOL that contains the flag that indicates that property values are restricted.

Put method:

  • varIsRestricted
    [in] VARIANT_BOOL that contains the flag that indicates that property values are restricted.
Return Values

For a list of error messages returned by SharePoint Portal Server, see Error Messages.

Remarks

The default value of VARIANT_TRUE indicates that a property can be set only to a value that is included in the dictionary list defined by the DictionaryValues property. All other property values are invalid. If this property is set to VARIANT_FALSE, a property can be set to any value.

Example

To see this property in a fuller context, see Document Management Object Model Sample.