IUrlHistoryStg2::AddUrlAndNotify method

  • Article

Provides an advanced method to add a URL to the Windows Internet Explorer history.

Syntax

HRESULT AddUrlAndNotify(
  [in] LPCOLESTR         pocsUrl,
  [in] LPCOLESTR         pocsTitle,
  [in] DWORD             dwFlags,
  [in] BOOL              fWriteHistory,
  [in] IOleCommandTarget *poctNotify,
  [in] IUnknown          *punkISFolder
);

Parameters

  • pocsUrl [in]
    The URL to place in the history.

  • pocsTitle [in]
    A pointer to a variable of type LPCOLESTR that specifies the title for this URL. If NULL, no title is added.

  • dwFlags [in]
    Not implemented.

  • fWriteHistory [in]
    A BOOL that enables writing to the date-history containers. TRUE enables writing to the date-history containers. FALSE disables writing to the date-history containers.

  • poctNotify [in]
    If fWriteHistory is set to TRUE, the Exec method of the IOleCommandTarget interface is called and passed the CGID_Explorer flag, the SBCMDID_SELECTHISTPIDL flag, and the OLECMDEXECOPT_PROMPTUSER flag, with a variant that contains the appropriate PIDL.

  • punkISFolder [in]
    The history Shell folder where the date containers are stored. If a location is not provided, the default location is used. In most cases, the calling function should specify null.

Return value

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

Requirements

Minimum supported client

Windows XP, Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Product

Internet Explorer 5.5

Header

 Urlhist.h

IDL

 Urlhist.idl

DLL

 Shdocvw.dll

See also

IUrlHistoryStg2