Share via

3.1.4.2.10 put_Description (Opnum 16)

  • Article

The put_Description method sets the Description property of the event class. 

 [propput, id(5), helpstring("property Description")] HRESULT Description(
   [in] BSTR bstrDescription
 );

bstrDescription: The Description property of the event class, as specified in section 3.1.1.1. The string value MUST be of length less than or equal to 255.

Return Values: An HRESULT specifying success or failure. All success codes MUST be treated the same, and all failure codes MUST be treated the same.

When this method is invoked, the server MUST validate the new value of the property for syntax. If validation fails, the server MUST fail the method call. Otherwise, the server MUST attempt to update the state of the DCOM object servicing this method with the new value of the Description property, and fail the call, returning a failure HRESULT back to the client if it cannot. Otherwise, it MUST override any previous value that was set for this DCOM object instance servicing this method call