{"id":4633,"date":"2009-02-18T22:22:00","date_gmt":"2009-02-18T22:22:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/vcblog\/2009\/02\/18\/mfc-restart-manager-support-in-vs2010\/"},"modified":"2019-02-18T18:53:54","modified_gmt":"2019-02-18T18:53:54","slug":"mfc-restart-manager-support-in-vs2010","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/mfc-restart-manager-support-in-vs2010\/","title":{"rendered":"MFC Restart Manager Support in VS2010"},"content":{"rendered":"

Hi, I am Weidong Huang, a Software Design Engineer in Test in the Visual C++ group.  <\/span>Today I am going to talk about MFC\u2019s support of Restart Manager functionality — a very amazing feature in VS2010.<\/span><\/span><\/font><\/p>\n

 <\/font><\/span><\/b><\/p>\n

What is Restart Manager?<\/font><\/span><\/b><\/p>\n

Restart Manager is a new feature introduced by Microsoft\u2019s Windows Vista operating system.  <\/span>It can help applications maintain their data when <\/span>an update needs to shutdown the application or when an unexpected software error or crash occurs. Instead of shutting down abnormally, Restart Manager enables <\/span>an application to perform an application save before it is terminated. Fu<\/span>rthermore, it can re-invoke the application enabling it to restore its state from before the <\/span>shutdown or crash.  <\/span><\/span><\/font><\/font><\/p>\n

<\/span><\/span><\/font><\/font> <\/p>\n

What Restart Manager support can you get from MFC in VS2010?<\/font><\/span><\/b><\/p>\n

\u00b7<\/font>         <\/span><\/span><\/span>For new MFC applications, you can get the application restart and recovery feature for free by using the MFC Application Wizard. <\/span><\/font><\/font><\/p>\n

\u00b7<\/font>         <\/span><\/span><\/span>All configurable parts of the restart manager API are<\/span> exposed to the user through overridabl<\/span>e virtual members.<\/span><\/font><\/font><\/p>\n

\u00b7<\/font>         <\/span><\/span><\/span>To upgrade an existing application to get the default restart manager support, you only need to add a single line of code. <\/span><\/font><\/font><\/p>\n

\u00b7<\/font>         <\/span><\/span><\/span>An auto-save mechanism is<\/span> added to the application<\/span> that performs the saving of open documents to temporary files in user-definable intervals. If an application crashes due to an exception, the application will be restarted restoring the last backup.<\/span><\/font><\/font><\/p>\n

\u00b7<\/font>         <\/span><\/span><\/span>A restore on restart UI prompts the end user to recover auto-saved versions if available.<\/font><\/font><\/p>\n

 <\/font><\/p>\n

How to enable Restart Manager in VS2010?<\/font><\/span><\/b><\/p>\n

The MFC Restart Manager in VS2010 includes two levels of supports:<\/font><\/font><\/span><\/p>\n

\u00b7<\/font>         <\/span><\/span><\/span>Restart Support<\/font><\/font><\/b><\/p>\n

o<\/font>   <\/span><\/span><\/span>Restart the application after upgrade or crash<\/font><\/font><\/p>\n

Note: <\/b>This applies to all types of MFC applications<\/font><\/font><\/p>\n

\u00b7<\/font>         <\/span><\/span><\/span>Application Recover Support: <\/font><\/font><\/b><\/p>\n

o<\/font>   <\/span><\/span><\/span>Reopen the previously opened document<\/font><\/font><\/p>\n

o<\/font>   <\/span><\/span><\/span>Recover the auto saved document<\/font><\/font><\/p>\n

                <\/span>Note:<\/b> This only applies to Doc\/View type MFC applications and needs restart support. <\/b><\/font><\/font><\/p>\n

 <\/font><\/p>\n

Enabling restart manager support steps are different between new application and existing application:<\/font><\/font><\/p>\n

 <\/font><\/b><\/p>\n

For new application, you only need 2 steps:<\/font><\/font><\/b><\/p>\n

1.<\/font>       <\/span><\/span><\/span>Use MFC Application Wizard to Create a new MFC Application;<\/font><\/font><\/p>\n

2.<\/font>       <\/span><\/span><\/span>In Advance Features page, select Support Restart Manager (see following).  <\/span><\/font><\/font><\/p>\n

<\/span><\/font><\/font> <\/p>\n

<\/span><\/font><\/font><\/p>\n

 <\/font><\/font><\/p>\n

<\/font><\/font> <\/p>\n

<\/span><\/p>\n

There are 3 options for selection:<\/font><\/font><\/p>\n

a.<\/font>       <\/span><\/span><\/span>Select \u201cSupport Restart Manager\u201d only<\/font><\/font><\/p>\n

This option will enable your application with restart support only.  <\/span>In other words, the application will be restarted after upgrade shutdown or crash but no attempt will be made to reopen documents or recover documents.<\/font><\/font><\/p>\n

b.<\/font>      <\/span><\/span><\/span>Select \u201cSupport Restart Manager\u201d and \u201cReopen previously open documents\u201d<\/font><\/font><\/p>\n

Besides the functionality described in a), this option enables your application to reopen previous open documents but no attempt to recover an auto-saved version of the document is made. <\/font><\/font><\/p>\n

c.<\/font>       <\/span><\/span><\/span>Select \u201cSupport Restart Manager\u201d , \u201cReopen previously open documents\u201d and \u201cSupport application recovery\u201d<\/font><\/font><\/p>\n

Besides the functionality described in a) and b), restart manager will try to recover the documents with an auto-save version.  <\/span>It will prompt with a TaskDialog (Unicode) or MessageBox(Non Unicode) and ask user whether to recover the documents.  <\/span>If user chooses \u201cYes\u201d, the auto-save documents will be opened and used as current documents. If user choose \u201cNo\u201d, the last user saved documents will be opened and the auto-save changes will be discarded.<\/font><\/font><\/p>\n

 <\/font><\/p>\n

Note:  <\/span><\/font><\/font><\/b><\/p>\n

1.<\/font>       <\/span><\/span><\/span><\/b>To select b), you need to select a), and to select c), you need to select b).  <\/span><\/font><\/font><\/b><\/p>\n

2.<\/font>       <\/span><\/span><\/span><\/b>For Dialog type Application, b and c will be disabled automatically.<\/font><\/font><\/b><\/p>\n

 <\/font><\/p>\n

For existing application, you only need add only one line of code in App Class constructor, the code could be: (these 3 lines of code perform the same functionalities as above a, b and c respectively)<\/font><\/font><\/b><\/p>\n

a.<\/font>       <\/span><\/span><\/span>m_dwRestartManagerSupportFlags = AFX_RESTART_MANAGER_SUPPORT_RESTART; <\/font><\/font><\/p>\n

b.<\/font>      <\/span><\/span><\/span>m_dwRestartManagerSupportFlags = <\/font><\/font><\/p>\n

AFX_RESTART_MANAGER_SUPPORT_RESTART_ASPECTS;<\/font><\/font><\/p>\n

c.<\/font>       <\/span><\/span><\/span>m_dwRestartManagerSupportFlags = AFX_RESTART_MANAGER_SUPPORT_ALL_ASPECTS;<\/font><\/font><\/p>\n

 <\/font><\/p>\n

Example:<\/font><\/font><\/p>\n

CMyApp::CMyApp()<\/font><\/font><\/span><\/p>\n

{<\/font><\/font><\/span><\/p>\n

                <\/span>m_dwRestartManagerSupportFlags = AFX_RESTART_MANAGER_SUPPORT_RESTART;<\/font><\/font><\/span><\/p>\n

 <\/font><\/span><\/p>\n

\/\/other initialize codes<\/font><\/font><\/span><\/p>\n

}<\/span><\/font><\/font><\/p>\n

 <\/font><\/p>\n

Tips to use Restart Manager in VS2010<\/font><\/span><\/b><\/p>\n

1.<\/font>       <\/span><\/span><\/span>Use CDataRecoveryHandler::SetAutoSaveInterval to adjust the auto save interval for your special needs.  <\/span>The default value is 5 minutes.  <\/span>You can get default CDataRecoveryHandler by calling \u201cAfxGetApp()->GetDataRecoveryHandler()\u201d.<\/font><\/font><\/p>\n

2.<\/font>       <\/span><\/span><\/span>Although the default implementation of Restart Manager will be enough for most users, you may want to implement a different data recovery strategy for your application.  <\/span>In this case, overload CWinApp::GetDataRecoveryHandler() and attach your own DataRecoveryHandler derived from CDataRecoveryHandler.  <\/span>Since this is not a common user scenario, I am not covering the usage of this functionality today. For information on how to implement your own DataRecoveryHandler, please refer to the MSDN document which will be published with VS2010.  <\/span><\/font><\/font><\/p>\n

3.<\/font>       <\/span><\/span><\/span>To test your application\u2019s restart and recovery capabilities, you can embed crash code to simulate the crash scenario and use \u201cRmStartSession \u201c, \u201cRmRegisterResources\u201d and \u201cRmShutdown\u201d and \u201cRmRestart\u201d Windows APIs to simulate windows upgrade scenario. <\/font><\/font><\/p>\n

Example code of using \u201cRm*\u201d APIs:<\/font><\/font><\/p>\n

#include “windows.h”<\/font><\/font><\/span><\/p>\n

#include “RestartManager.h”<\/font><\/font><\/span><\/p>\n

int wmain(int argc, WCHAR* argv[])<\/font><\/font><\/span><\/p>\n

{<\/font><\/font><\/span><\/p>\n

        <\/span>DWORD dwSessionHandle = 0;<\/font><\/font><\/span><\/p>\n

        <\/span>WCHAR wszSessionKey[CCH_RM_SESSION_KEY+1];<\/font><\/font><\/span><\/p>\n

        <\/span>LPCWSTR pwzResourcesToRestart[] = {argv[1]};<\/font><\/font><\/span><\/p>\n

        <\/span>if (RmStartSession(&dwSessionHandle, 0, wszSessionKey) == ERROR_SUCCESS)<\/font><\/font><\/span><\/p>\n

        <\/span>{<\/font><\/font><\/span><\/p>\n

                        <\/span>if (RmRegisterResources(dwSessionHandle, 1, pwzResourcesToRestart, 0, NULL, 0, NULL) == ERROR_SUCCESS)<\/font><\/font><\/span><\/p>\n

                        <\/span>{<\/font><\/font><\/span><\/p>\n

                                        <\/span>if (RmShutdown(dwSessionHandle, RmShutdownOnlyRegistered, NULL) == ERROR_SUCCESS)<\/font><\/font><\/span><\/p>\n

                                        <\/span>{<\/font><\/font><\/span><\/p>\n

                                                        <\/span>if (RmRestart(dwSessionHandle, 0, NULL) == ERROR_SUCCESS)<\/font><\/font><\/span><\/p>\n

                                                        <\/span>{<\/font><\/font><\/span><\/p>\n

                                                                        <\/span>return 0;<\/font><\/font><\/span><\/p>\n

                                                        <\/span>}<\/font><\/font><\/span><\/p>\n

                                        <\/span>}<\/font><\/font><\/span><\/p>\n

                        <\/span>}<\/font><\/font><\/span><\/p>\n

        <\/span>}<\/font><\/font><\/span><\/p>\n

}<\/font><\/font><\/span><\/p>\n

 <\/font><\/p>\n

Hope you like the feature. Let me know if you have any comments on this blog. <\/font><\/span><\/p>\n

 <\/font><\/span><\/p>\n

Thanks
Weidong Huang
Visual C++ Library QA Team<\/font><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

Hi, I am Weidong Huang, a Software Design Engineer in Test in the Visual C++ group.  Today I am going to talk about MFC\u2019s support of Restart Manager functionality — a very amazing feature in VS2010.   What is Restart Manager? Restart Manager is a new feature introduced by Microsoft\u2019s Windows Vista operating system.  It can […]<\/p>\n","protected":false},"author":289,"featured_media":35994,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-4633","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-cplusplus"],"acf":[],"blog_post_summary":"

Hi, I am Weidong Huang, a Software Design Engineer in Test in the Visual C++ group.  Today I am going to talk about MFC\u2019s support of Restart Manager functionality — a very amazing feature in VS2010.   What is Restart Manager? Restart Manager is a new feature introduced by Microsoft\u2019s Windows Vista operating system.  It can […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/4633","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/users\/289"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/comments?post=4633"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/4633\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media\/35994"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media?parent=4633"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/categories?post=4633"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/tags?post=4633"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}