Share via

GetLineInfo method

  • Article

Gets information about the line that the display pointer is on.

Syntax

HRESULT retVal = object.GetLineInfo(ppLineInfo);

Parameters

  • ppLineInfo [out]
    Type: ILineInfo

    A pointer to an ILineInfo interface from which to access the line information.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The ILineInfo interface that this method gets provides information about the location of a display pointer on the screen. For instance, ILineInfo::x provides the horizontal distance from the display pointer to the left side of the element containing it. ILineInfo::baseLine gives a vertical position for the display pointer relative to the top of the containing element. IDisplayServices::TransformPoint is useful for converting these coordinates to an appropriate frame of reference.