3.2.4.2.35.4 Description (get) (Opnum 10)

  • Article

The Description (get) method returns the description of the report.

 [propget, id(FSRM_PROPERTY (FSRM_DISPID_REPORT | 0x03))] HRESULT Description(
   [out, retval] BSTR* description
 );

description: Pointer to a variable that upon completion contains the description of the report.

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

Return value/code

Description

0x80070057

E_INVALIDARG

The description parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that description is not NULL.

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

The server MUST set description to the report's Report.Description.