3.2.4.2.27.4 MatchesSourceTemplate (get) (Opnum 20)

The MatchesSourceTemplate (get) method returns whether this file screen object's properties match those of the template it was derived from or not.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_FILESCREEN | 0x03))] HRESULT MatchesSourceTemplate(
   [out, retval] VARIANT_BOOL* matches
 );

matches: Pointer to a variable that upon completion contains whether this file screen object's properties match the template it was derived from or not.

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

Return value/code

Description

0x80070057

E_INVALIDARG

The matches parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that matches is not NULL.

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

The server MUST do one of the following or return a nonzero error code.

  • If the file screen object was not derived from a template, the server MUST return S_FALSE.

  • If all the file screen object's properties match those of the file screen template that it was derived from, the server MUST set matches to VARIANT_TRUE.

  • If any of the file screen object's properties do not match those of the file screen template that it was derived from, the server MUST set matches to VARIANT_FALSE.