Share via

3.2.4.2.2.3 RemoveById (Opnum 16)

  • Article

The RemoveById method removes from the collection of Objects Being Enumerated the object whose ID matches the specified id.

 [id(FSRM_DISPID_COLLECTION_MUTABLE | 0x03)] HRESULT RemoveById(
   [in] FSRM_OBJECT_ID id
 );

id: The ID to match for identifying the object to be removed.

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

Return value/code

Description

0x80045301

FSRM_E_NOT_FOUND

An object with the specified ID was not found in the collection.

The server MUST remove the matching item from the collection of Objects Being Enumerated or return a nonzero error code.

If no object in the collection of Objects Being Enumerated has an ID that matches the specified id, return FSRM_E_NOT_FOUND.

If the Objects Being Enumerated contained in the collection of Objects Being Enumerated are not VT_UNKNOWN or VT_DISPATCH types, return E_INVALIDARG.