GetRequiredPropertyState method

Returns the required property state for a linked file.

When adding files to a linked folder or standard eRoom folder that has mandatory properties via the eRoom browser UI, eRoom automatically opens a webtop properties component to fill in these required properties. When adding a file via SAAPI or XML to a location that requires properties, the file is put into a ”pending” state, indicating that required properties have not been specified. Files remain in this state until properties are provided via the eRoom/Webtop ”Cont Server Properties&ldots;” dialog. Once properties are provided, the item state changes to ”confirmed”.

Syntax

C++

HRESULT GetRequiredPropertyState(
   IERUFile* pFile,
   ERUExtPropertyState* pPropertyState)

Scripting languages
pPropertyState = Object.GetRequiredPropertyState(
   pFile as IERUFile)

Parameters

pFile

The file for which you want to obtain the required property state.

pPropertyState

Upon return, an ERUExtPropertyState enum describing the required property state of the file.

Return value

C++

The return code.
Scripting languages

Upon return, an ERUExtPropertyState enum describing the required property state of the file.

Home

Applies to
IERUExternalStorageManager