3.2.4.2.29.6 CreateFileScreenException (Opnum 12)

The CreateFileScreenException method creates a Non-Persisted File Screen Exception Instance (section 3.2.1.3.2.2) on the specified path.

 [id(FSRM_DISPID_FILESCREEN_MANAGER | 0x04)] HRESULT CreateFileScreenException(
   [in] BSTR path,
   [out, retval] IFsrmFileScreenException** fileScreenException
 );

path: Contains the path of the directory to put the file screen exception on.

fileScreenException: Pointer to an IFsrmFileScreenException interface pointer (section 3.2.4.2.28) that upon completion contains a pointer to the newly created file screen exception. To have the file screen exception added to the server's List of Persisted File Screen Exceptions (section 3.2.1.3), the caller MUST call Commit (section 3.2.4.2.28.1). The caller MUST release the file screen exception when it is done with it.

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

Return value/code

Description

0x80045306

FSRM_E_INVALID_PATH

The content of the path parameter exceeds the maximum length of 260 characters.

0x80070057

E_INVALIDARG

The fileScreenException parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that fileScreenException 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 Exception Instance (section 3.2.1.3.2.2) with the File Screen Exception.Folder path set to the specified path.

    • Set FSRM Base Object.Id to a GUID.

    • Set Allowed file groups to an empty list.

  • Set fileScreenException to the IFsrmFileScreenException interface pointer of the newly created Non-Persisted File Screen Exception Instance.

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