3.2.4.2.29.7 GetFileScreenException (Opnum 13)
The GetFileScreenException method returns the file screen exception from the List of Persisted File Screen Exceptions (section 3.2.1.3) for the specified path.
-
[id(FSRM_DISPID_FILESCREEN_MANAGER | 0x05)] HRESULT GetFileScreenException( [in] BSTR path, [out, retval] IFsrmFileScreenException** fileScreenException );
path: Contains the path of the file screen exception to return.
fileScreenException: Pointer to an IFsrmFileScreenException interface pointer (section 3.2.4.2.28) that upon completion contains a pointer to the file screen exception for the specified path. 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
0x80045301
FSRM_E_NOT_FOUND
A file screen exception has not been applied to the specified directory.
0x80045304
FSRM_E_PATH_NOT_FOUND
The file screen exception for the specified path could not be found.
0x80045306
FSRM_E_INVALID_PATH
The content of the path parameter exceeds the maximum length of 260 characters.
0x80070057
E_INVALIDARG
This code is returned for the following reasons:
The path parameter is NULL.
The fileScreenException parameter is NULL.
Upon receiving this message, the server MUST validate parameters:
Verify that path is not NULL.
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 or return a nonzero error code.
Create a new Non-Persisted File Screen Exception Instance (section 3.2.1.3.2.2).
Populate its configuration data from the Persisted File Screen Exception (section 3.2.1.3.2.1) in the List of Persisted File Screen Exceptions with the specified path.
Set fileScreenException to the IFsrmFileScreenException interface pointer of the newly created Non-Persisted File Screen Exception Instance.
If a file screen exception does not exist for the specified path, the server MUST return FSRM_E_NOT_FOUND.