3.2.4.2.32.1 CreateTemplate (Opnum 7)

The CreateTemplate method creates a blank Non-Persisted File Screen Template Instance (section 3.2.1.3.3.2).

 [id(FSRM_DISPID_FILESCREEN_TEMPLATE_MANAGER | 0x01)] HRESULT CreateTemplate(
   [out, retval] IFsrmFileScreenTemplate** fileScreenTemplate
 );

fileScreenTemplate: Pointer to an IFsrmFileScreenTemplate interface pointer (section 3.2.4.2.30) that upon completion points to a blank file screen template. The caller MUST release the template 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

0x80070057

E_INVALIDARG

The fileScreenTemplate parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that fileScreenTemplate is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

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

  • Create a new Non-Persisted File Screen Template Instance.

    • Set FSRM Base Object.Id to a GUID.

    • Set File Screen Template.Name to an empty string.

    • Set Blocked file groups to an empty list.

    • Set Notifications to an empty list.

    • Set File screen mode to Hard screen.

  • Set fileScreenTemplate to the IFsrmFileScreenTemplate inteface pointer for the newly created Non-Persisted File Screen Template Instance.

The new Non-Persisted File Screen Template Instance MUST NOT be associated with an existing Persisted File Screen Template (section 3.2.1.3.3.1).