3.2.4.2.32.3 EnumTemplates (Opnum 9)

The EnumTemplates method returns all the file screen templates from the List of Persisted File Screen Templates (section 3.2.1.3) of the server.

 [id(FSRM_DISPID_FILESCREEN_TEMPLATE_MANAGER | 0x03)] HRESULT EnumTemplates(
   [in, defaultvalue(FsrmEnumOptions_None)] 
     FsrmEnumOptions options,
   [out, retval] IFsrmCommittableCollection** fileScreenTemplates
 );

options: Contains the FsrmEnumOptions (section 2.2.1.2.5) to use when enumerating the file screen templates.

fileScreenTemplates: Pointer to an IFsrmCommittableCollection interface pointer (section 3.2.4.2.3) that upon completion contains pointers to every file screen template on the server. The caller MUST release the collection when the caller is done with it.

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

Return value/code

Description

0x80045311

FSRM_E_NOT_SUPPORTED

The options parameter contains FsrmEnumOptions (section 2.2.1.2.5 ) values that are not valid.

0x80070057

E_INVALIDARG

The fileScreenTemplate parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • If fileScreenTemplates is NULL, the server MUST return E_INVALIDARG.

  • If options contains FsrmEnumOptions_Asynchronous or any value other than what is specified in section 2.2.1.2.5, the server MUST return FSRM_E_NOT_SUPPORTED.

Upon successful validation of parameters, the server MUST perform the following actions: