3.2.4.2.29.4 GetFileScreen (Opnum 10)

  • Article

The GetFileScreen method returns the file screen from the List of Persisted File Screens (section 3.2.1.3) for the specified path.

 [id(FSRM_DISPID_FILESCREEN_MANAGER | 0x02)] HRESULT GetFileScreen(
   [in] BSTR path,
   [out, retval] IFsrmFileScreen** fileScreen
 );

path: Contains the path of the file screen to return.

fileScreen: Pointer to an IFsrmFileScreen interface pointer (section 3.2.4.2.27) that upon completion contains a pointer to the file screen for the specified path. The caller MUST release the file screen 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

0x80045304

FSRM_E_PATH_NOT_FOUND

The file screen 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 fileScreen parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that path is not NULL.

  • Verify that fileScreen 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.

If a file screen does not exist for the specified path, the server MUST return FSRM_E_NOT_FOUND.