3.2.4.2.29.2 ActionVariableDescriptions (Opnum 8)

  • Article

The ActionVariableDescriptions method returns descriptions for the macros (File Screen Macros (section 3.2.4.3.2) and General Macros (section 3.2.4.3.4)) that are returned by the ActionVariables (section 3.2.4.2.29.1) method.

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_FILESCREEN_MANAGER | 0x02))] HRESULT ActionVariableDescriptions(
   [out, retval] SAFEARRAY (VARIANT)* descriptions
 );

descriptions: A pointer to a SAFEARRAY that upon completion contains the descriptions for the macros returned by ActionVariables.

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

Return value/code

Description

0x80070057

E_INVALIDARG

The descriptions parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that descriptions is not NULL.

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

The server MUST populate descriptions with the descriptions for the macros returned by ActionVariables.