3.2.4.2.31.1 OverwriteOnCommit (get) (Opnum 22)

The OverwriteOnCommit (get) method returns the overwrite-on-commit property of the imported file screen template.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_FILESCREEN_TEMPLATE_IMPORTED | 0x01))] HRESULT OverwriteOnCommit(
   [out, retval] VARIANT_BOOL* overwrite
 );

overwrite: Pointer to a variable that upon completion contains the overwrite-on-commit property of the imported file screen template.

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

Return value/code

Description

0x80070057

E_INVALIDARG

The overwrite parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that overwrite is not NULL.

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

The server MUST set overwrite to the File Screen.Overwrite on commit property of the imported file screen template.