IOleControlSite::TransformCoords method

Converts coordinates expressed in HIMETRIC units (as is standard in OLE) to the units specified by the container.

Syntax

HRESULT TransformCoords(
  [in, out] POINTL *pPtlHimetric,
  [in, out] POINTF *pPtfContainer,
  [in]      DWORD  dwFlags
);

Parameters

pPtlHimetric [in, out]

Address of a POINTL structure containing coordinates expressed in HIMETRIC units. This is an [in] parameter when dwFlags contains XFORMCOORDS_HIMETRICTOCONTAINER; it is an [out] parameter with XFORMCOORDS_CONTAINERTOHIMETRIC. In the latter case, the contents are undefined on error.

pPtfContainer [in, out]

Address of a caller-allocated POINTF structure that receives the converted coordinates. This is an [in] parameter when dwFlags contains XFORMCOORDS_CONTAINERTOHIMETRIC; it is an [out] parameter with XFORMCOORDS_HIMETRICTOCONTAINER. In the latter case, the contents are undefined on error.

dwFlags [in]

Flags indicating the exact conversion to perform. This parameter can be any combination of the following values, except as indicated.

Value	Meaning
XFORMCOORDS_POSITION 0x1	The coordinates to convert represent a position point. Cannot be used with XFORMCOORDS_SIZE.
XFORMCOORDS_SIZE 0x2	The coordinates to convert represent a set of dimensions. Cannot be used with XFORMCOORDS_POSITION.
XFORMCOORDS_HIMETRICTOCONTAINER 0x4	The operation converts pptlHimetric into pptfContainer. Cannot be used with XFORMCOORDS_CONTAINERTOHIMETRIC.
XFORMCOORDS_CONTAINERTOHIMETRIC 0x8	The operation converts pptfContainer into pptlHimetric. Cannot be used with XFORMCOORDS_HIMETRICTOCONTAINER.
XFORMCOORDS_EVENTCOMPAT 0x10	The operation maintains compatibility with an event.

 

Return value

This method can return the standard return values E_INVALIDARG and E_UNEXPECTED, as well as the following values.

Remarks

A control uses this method when it has to send coordinates to a container within an event or some other custom call or when the control has container coordinates that it needs to convert into HIMETRIC units.

Requirements

See also

IOleControlSite