IOleObject::SetColorScheme method

Specifies the color palette that the object application should use when it edits the specified object.

Syntax

HRESULT SetColorScheme(
  LOGPALETTE *pLogpal
);

Parameters

pLogpal

Pointer to a LOGPALETTE structure that specifies the recommended palette.

Return Value

This method returns S_OK on success. Other possible return values include the following.

Return code Description
E_NOTIMPL
Object does not support setting palettes.
OLE_E_PALETTE
Invalid LOGPALETTE structure pointed to by pLogPal.
OLE_E_NOTRUNNING
Object must be running to perform this operation.

Remarks

The IOleObject::SetColorScheme method sends the container application's recommended color palette to the object application, which is not obliged to use it.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header oleidl.h

See Also

IOleObject