3.2.4.2.10.2 Description (get) (Opnum 8)

• 10/30/2020
• 2 minutes to read

The Description (get) method returns the FSRM Base Object.Description of the object.

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

description: Pointer to a variable that upon completion contains the FSRM Base Object.Description of the object.

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 FSRM Base Object.Description of the object.