Share via

GetRelativeEntry method

  • Article

Gets an entry from the travel log.

Syntax

var retval = TravelLogStg.GetRelativeEntry(iOffset);

Parameters

  • iOffset [in]
    Type: int

    An integer that specifies an offset relative to the current position.

  • ptle [out]
    Type: ITravelLogEntry

    A pointer to the entry at the specified offset.

Return value

Type: HRESULT

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

Remarks

ITravelLogStg::GetRelativeEntry returns the entry specified by the offset. A positive offset returns an entry after the current entry; a negative offset returns an entry before the current entry. Zero returns the current entry.