3.2.4.2.47.2 Capabilities (get) (Opnum 31)

  • Article

The Capabilities (get) method retrieves the Capabilities of the storage module and returns S_OK upon successful completion.<73>

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_STORAGE_MODULE_DEFINITION | 0x01))] HRESULT Capabilities(
   [out, retval] FsrmStorageModuleCaps* capabilities
 );

capabilities: Pointer to a variable that upon completion contains the Capabilities of the storage module. For possible capabilities, see the FsrmStorageModuleCaps (section 2.2.2.8.1.1) enumeration.

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

Return value/code

Description

0x80070057

E_INVALIDARG

This code is returned for the following reasons:

  • The capabilities parameter is NULL.

  • One or more of the values specified in the capabilities parameter is not a valid FsrmStorageModuleCaps (section 2.2.2.8.1.1) value.

Upon receiving this message, the server MUST validate parameters:

  • Verify that capabilities is not NULL.

  • Verify that capabilities contains valid FsrmStorageModuleCaps values.

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

The server MUST set capabilities to the Capabilities of the storage module.