IWebHistory Interface Reference

import"IWebHistory.idl";

Inheritance diagram for IWebHistory:

Public Member Functions
HRESULT	optionalSharedHistory ([out, retval] IWebHistory **history)
HRESULT	setOptionalSharedHistory ([in] IWebHistory *history)
HRESULT	unused1 ()
HRESULT	unused2 ()
HRESULT	addItems ([in] int itemCount, [in] IWebHistoryItem **items)
HRESULT	removeItems ([in] int itemCount, [in] IWebHistoryItem **items)
HRESULT	removeAllItems ()
HRESULT	orderedLastVisitedDays ([in, out] int *count, [in] DATE *calendarDates)
HRESULT	orderedItemsLastVisitedOnDay ([in, out] int *count, [in] IWebHistoryItem **items, [in] DATE calendarDate)
HRESULT	itemForURL ([in] BSTR url, [out, retval] IWebHistoryItem **item)
HRESULT	setHistoryItemLimit ([in] int limit)
HRESULT	historyItemLimit ([out, retval] int *limit)
HRESULT	setHistoryAgeInDaysLimit ([in] int limit)
HRESULT	historyAgeInDaysLimit ([out, retval] int *limit)

Member Function Documentation

addItems()

HRESULT IWebHistory::addItems	(	[in] int	itemCount,
		[in] IWebHistoryItem **	items
	)

addItems:

Parameters

newItems

An array of WebHistoryItems to add to the WebHistory. (void)addItems:(NSArray *)newItems;

historyAgeInDaysLimit()

HRESULT IWebHistory::historyAgeInDaysLimit

(

[out, retval] int *

limit

)

historyAgeInDaysLimit

Returns

Returns the maximum number of days to be read from stored history.

• (int)historyAgeInDaysLimit;

historyItemLimit()

HRESULT IWebHistory::historyItemLimit

(

[out, retval] int *

limit

)

historyItemLimit

Returns

The maximum number of items that will be stored by the WebHistory.

• (int)historyItemLimit;

itemForURL()

HRESULT IWebHistory::itemForURL	(	[in] BSTR	url,
		[out, retval] IWebHistoryItem **	item
	)

itemForURL: Get an item for a specific URL

Parameters

URL	The URL of the history item to search for

Returns

Returns an item matching the URL

• (WebHistoryItem *)itemForURL:(NSURL *)URL;

optionalSharedHistory()

HRESULT IWebHistory::optionalSharedHistory

(

[out, retval] IWebHistory **

history

)

optionalSharedHistory Returns a shared WebHistory instance initialized with the default history file.

Returns

A WebHistory object.

• (WebHistory *)optionalSharedHistory;

orderedItemsLastVisitedOnDay()

HRESULT IWebHistory::orderedItemsLastVisitedOnDay	(	[in, out] int *	count,
		[in] IWebHistoryItem **	items,
		[in] DATE	calendarDate
	)

orderedItemsLastVisitedOnDay: Get an array of WebHistoryItem that were last visited on the day represented by the specified NSCalendarDate, ordered from most recent to oldest.

Parameters

calendarDate

A date identifying the unique day of interest.

Returns

Returns an array of WebHistoryItems last visited on the indicated day.

ADVISORY NOTE: This method may change for the 1.0 SDK.

• (NSArray *)orderedItemsLastVisitedOnDay:(NSCalendarDate *)calendarDate;

orderedLastVisitedDays()

HRESULT IWebHistory::orderedLastVisitedDays	(	[in, out] int *	count,
		[in] DATE *	calendarDates
	)

orderedLastVisitedDays Get an array of NSCalendarDates, each one representing a unique day that contains one or more history items, ordered from most recent to oldest.

Returns

Returns an array of NSCalendarDates for which history items exist in the WebHistory.

ADVISORY NOTE: This method may change for the 1.0 SDK.

• (NSArray *)orderedLastVisitedDays;

removeAllItems()

HRESULT IWebHistory::removeAllItems

(

)

removeAllItems

• (void)removeAllItems;

Implemented in WebHistory, and WebHistory.

removeItems()

HRESULT IWebHistory::removeItems	(	[in] int	itemCount,
		[in] IWebHistoryItem **	items
	)

removeItems:

Parameters

items

An array of WebHistoryItems to remove from the WebHistory. (void)removeItems:(NSArray *)items;

setHistoryAgeInDaysLimit()

HRESULT IWebHistory::setHistoryAgeInDaysLimit

(

[in] int

limit

)

setHistoryAgeInDaysLimit: setHistoryAgeInDaysLimit: sets the maximum number of days to be read from stored history.

Parameters

limit

The maximum number of days to be read from stored history. (void)setHistoryAgeInDaysLimit:(int)limit;

Implemented in WebHistory.

setHistoryItemLimit()

HRESULT IWebHistory::setHistoryItemLimit

(

[in] int

limit

)

setHistoryItemLimit: Limits the number of items that will be stored by the WebHistory.

Parameters

limit

The maximum number of items that will be stored by the WebHistory. (void)setHistoryItemLimit:(int)limit;

Implemented in WebHistory.

setOptionalSharedHistory()

HRESULT IWebHistory::setOptionalSharedHistory

(

[in] IWebHistory *

history

)

setOptionalSharedHistory:

Parameters

history

The history to use for the global WebHistory. (void)setOptionalSharedHistory:(WebHistory *)history;

unused1()

HRESULT IWebHistory::unused1

(

)

Implemented in WebHistory.

unused2()

HRESULT IWebHistory::unused2

(

)

Implemented in WebHistory.

---

The documentation for this interface was generated from the following file:

• Source/WebKit/win/Interfaces/IWebHistory.idl