3.2.4.4.7 GetScheduleInfo (Opnum 13)

  • Article

The GetScheduleInfo method gets information about a specified schedule object.

 [id(7), helpstring("method GetScheduleInfo")] HRESULT GetScheduleInfo(
   [in] BSTR bstrScheduleName,
   [out] BSTR* pbstrScheduleXML
 );

bstrScheduleName: A string that specifies the name of the schedule object for which information is required.

If this parameter is NULL, E_INVALIDARG MUST be returned.

pbstrScheduleXML: A pointer to a string that returns the specified schedule object information structure, in the form of a Schedule element (section 2.2.5.26). Sample XML is provided in Schedule XML Example (section 4.2.22).

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.

0xC1FF0271

WRM_ERR_CAL_UNKNOWN_SCHEDULE

The specified schedule object does not exist.

Additional IWRMCalendar interface methods are specified in section 3.2.4.4.