CoGetTreatAsClass (Compact 2013)

3/26/2014

This function returns the CLSID of an object that can emulate the specified object.

Syntax

HRESULT CoGetTreatAsClass(
  REFCLSID clsidOld,
  LPCLSID pclsidNew
);

Parameters

  • clsidOld
    [in] CLSID of the object that can be emulated (treated as) an object with a different CLSID.
  • pclsidNew
    [out] Pointer to where the CLSID that can emulate clsidOld objects is retrieved. This parameter cannot be NULL. If there is no emulation information for clsidOld objects, the clsidOld parameter is supplied.

Return Value

  • S_OK
    A new CLSID was successfully returned.
  • S_FALSE
    No emulation information for the clsidOld parameter and that the pclsidNew parameter is set to clsidOld.
  • REGDB_E_READREGDB
    An error reading the registry.

This function can also return any of the error values returned by the CLSIDFromString function.

Remarks

CoGetTreatAsClass returns the TreatAs entry in the registry for the specified object. The TreatAs entry, if set, is the CLSID of a registered object (an application) that can emulate the object in question. The TreatAs entry is set through a call to the CoTreatAsClass function.

Emulation allows an application to open and edit an object of a different format, while retaining the original format of the object. Objects of the original CLSID are activated and treated as objects of the second CLSID.

When the object is saved, this may result in loss of edits not supported by the original format. If there is no TreatAs entry for the specified object, this function returns the CLSID of the original object (clsidOld).

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

Header

objbase.h

Library

ole32.lib

See Also

Reference

COM Functions