Edit

CRecentFileList Class

  • Article

Supports control of the most recently used (MRU) file list.

Syntax

class CRecentFileList

Members

Public Constructors

Name Description
CRecentFileList::CRecentFileList Constructs a CRecentFileList object.

Public Methods

Name Description
CRecentFileList::Add Adds a file to the MRU file list.
CRecentFileList::GetDisplayName Provides a display name for menu display of an MRU filename.
CRecentFileList::GetSize Retrieves the number of files in the MRU file list.
CRecentFileList::ReadList Reads the MRU file list from the registry or .INI file.
CRecentFileList::Remove Removes a file from the MRU file list.
CRecentFileList::UpdateMenu Updates the menu display of the MRU file list.
CRecentFileList::WriteList Writes the MRU file list from the registry or .INI file.

Public Operators

Name Description
CRecentFileList::operator [ ] Returns a CString object at a given position.

Remarks

Files can be added to or deleted from the MRU file list, the file list can be read from or written to the registry or an .INI file, and the menu displaying the MRU file list can be updated.

Inheritance Hierarchy

CRecentFileList

Requirements

Header: afxadv.h

CRecentFileList::Add

Adds a file to the most recently used (MRU) file list.

virtual void Add(LPCTSTR lpszPathName);

virtual void Add(
    LPCTSTR lpszPathName,
    LPCTSTR lpszAppID);

void Add(
    IShellItem* pItem,
    LPCTSTR lpszAppID);

void Add(
    IShellLink* pLink,
    LPCTSTR lpszAppID);

void Add(
    PIDLIST_ABSOLUTE pidl,
    LPCTSTR lpszAppID);

Parameters

lpszPathName
Specifies pathname to be added to the list.

lpszAppID
Specifies Application User Model ID for the application.

pItem
Specifies a pointer to Shell Item to be added to the list.

pLink
Specifies a pointer to Shell Link to be added to the list.

pidl
Specifies the IDLIST for the shell item that should be added to the recent docs folder.

Remarks

The file name will be added to the top of the MRU list. If the file name already exists in the MRU list, it will be moved to the top.

CRecentFileList::CRecentFileList

Constructs a CRecentFileList object.

CRecentFileList(
    UINT nStart,
    LPCTSTR lpszSection,
    LPCTSTR lpszEntryFormat,
    int nSize,
    int nMaxDispLen = AFX_ABBREV_FILENAME_LEN);

Parameters

nStart
Offset for the numbering in the menu display of the MRU (most recently used) file list.

lpszSection
Points to the name of the section of the registry or the application's .INI file where the MRU file list is read and/or written.

lpszEntryFormat
Points to a format string to be used for the names of the entries stored in the registry or the application's .INI file.

nSize
Maximum number of files in the MRU file list.

nMaxDispLen
Maximum length, in characters, available for the menu display of a filename in the MRU file list.

Remarks

The format string pointed to by lpszEntryFormat should contain "%d", which will be used for substituting the index of each MRU item. For example, if the format string is "file%d" then the entries will be named file0, file1, and so on.

CRecentFileList::GetDisplayName

Obtains a display name for a file in the MRU file list, for use in the menu display of the MRU list.

virtual BOOL GetDisplayName(
    CString& strName,
    int nIndex,
    LPCTSTR lpszCurDir,
    int nCurDir,
    BOOL bAtLeastName = TRUE) const;

Parameters

strName
Full path of the file whose name is to be displayed in the menu list of MRU files.

nIndex
Zero-based index of the file in the MRU file list.

lpszCurDir
String holding the current directory.

nCurDir
Length of the current directory string.

bAtLeastName
If nonzero, indicates that the base name of the file should be returned, even if it exceeds the maximum display length (passed as the nMaxDispLen parameter to the CRecentFileList constructor).

Return Value

FALSE if there is no filename at the specified index in the most recently used (MRU) file list.

Remarks

If the file is in the current directory, the function leaves the directory off the display. If the filename is too long, the directory and extension are stripped. If the filename is still too long, the display name is set to an empty string unless bAtLeastName is nonzero.

CRecentFileList::GetSize

Retrieves the number of files in the MRU file list.

int GetSize() const;

Return Value

The number of files in the current most recently used (MRU) file list.

CRecentFileList::operator [ ]

The overloaded subscript ([]) operator returns a single CString specified by the zero-based index in nIndex.

CString& operator[ ](int nindex);

Parameters

nIndex
Zero-based index of a CString in a set of CStrings.

CRecentFileList::ReadList

Reads the most recently used (MRU) file list from the registry or the application's .INI file.

virtual void ReadList();

CRecentFileList::Remove

Removes a file from the MRU file list.

virtual void Remove(int nIndex);

Parameters

nIndex
Zero-based index of the file to be removed from the most recently used (MRU) file list.

CRecentFileList::UpdateMenu

Updates the menu display of the MRU file list.

virtual void UpdateMenu(CCmdUI* pCmdUI);

Parameters

pCmdUI
A pointer to the CCmdUI object for the most recently used (MRU) file list menu.

CRecentFileList::WriteList

Writes the most recently used (MRU) file list into the registry or the application's .INI file.

virtual void WriteList();

See also

Hierarchy Chart