3.2.4.2.1 ExportObjects (Opnum 7)

  • Article

The ExportObjects method creates XML for exporting objects.

 [id(1), helpstring("method ExportObjects")] HRESULT ExportObjects(
   [in] BSTR bstrObjectIds,
   [in] OBJECT_TYPE enumObjectType,
   [out] BSTR* pbstrObjectXml
 );

bstrObjectIds: A string that identifies the objects to be exported, in the format of an ObjectIds element (section 2.2.5.20).

enumObjectType: An OBJECT_TYPE enumeration value (section 2.2.3.6) that specifies the type of the objects to be exported. This determines the format of XML object returned in the pbstrObjectXml parameter, as follows.

Object type

XML object

OBJECT_SELECTION_CRITERIA

ProcessMatchingCriteria element (section 2.2.5.24)

OBJECT_POLICY

Policy element (section 2.2.5.21)

OBJECT_SCHEDULE

Calendar element (section 2.2.5.7) or Schedule element (section 2.2.5.26)

pbstrObjectXml: A pointer to a string that returns the XML for the objects to be exported. The format of the XML depends on the type of exported objects specified by the enumObjectType parameter.<35>

Return Values: This method returns 0x00000000 for success or a negative HRESULT value (in the following table or in [MS-ERREF] section 2.1.1) if an error occurs.

Return value/code

Description

0x00000000

S_OK

Operation successful.

0x80070057

E_INVALIDARG

One or more arguments are invalid.

Additional IResourceManager2 interface methods are specified in section 3.2.4.2.

The server SHOULD process this method call as follows.

  • If one or more ObjectIds XML elements included in the bstrObjectIds parameter cannot be found, they MUST be ignored, and the call MUST proceed for other ObjectIds.

  • If a PMC object is specified in the enumObjectType parameter, this method MUST return an XML string containing the requested PMCs in the configuration. The "Type" attributes of individual objects in the ObjectIds XML element MUST be ignored.

  • If a resource policy object is specified in the enumObjectType parameter, this method MUST return an XML string containing the requested RAPs in the configuration. The "Type" attributes of individual objects in the ObjectIds XML element MUST be ignored.

  • If a schedule object is specified in the enumObjectType parameter and the "Type" attribute of the object requested in the ObjectIds XML element is "Calendar", this method MUST return an XML string containing the requested calendar objects in the configuration.

  • If a schedule object is specified in the enumObjectType parameter and the "Type" attribute of the object requested in the ObjectIds XML element is not "Calendar", this method MUST return an XML string containing the requested schedule objects in the configuration.