Edit

Share via

ITravelLog::GetToolTipText method (shdeprecated.h)

  • Article

Deprecated. Gets tooltip text for a travel entry, which is used as a Unicode display string in the UI.

Syntax

HRESULT GetToolTipText(
  [in]  IUnknown *punk,
  [in]  int      iOffset,
  [in]  int      idsTemplate,
  [out] LPWSTR   pwzText,
  [in]  DWORD    cchText
);

Parameters

[in] punk

Type: IUnknown*

A pointer to an IUnknown representing the nearest browser or frame within which the travel generating the log is taking place.

[in] iOffset

Type: int

The number of travel entries forward (a positive value) or backward (a negative value) to move in the travel log to arrive at the travel entry from which text should be retrieved.

[in] idsTemplate

Type: int

Not used.

[out] pwzText

Type: LPWSTR

A pointer to a buffer that receives the Unicode tooltip text string.

[in] cchText

Type: DWORD

The number of characters in the buffer pointed to by pwzText.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Target Platform Windows
Header shdeprecated.h