CDocTemplate::GetDocString

發行項
06/10/2015

擷取字串與文件類型。

virtual BOOL GetDocString( 
   CString& rString, 
   enum DocStringIndex index  
) const;

參數

rString
其會包含字串的 CString 物件的參考，則函式會傳回。
Index - 索引
從描述資料型別的資料擷取的子字串的索引。這個參數的值可以是下列其中一個：
- 例如在應用程式視窗的標題列中的CDocTemplate::windowTitle 名稱 (「，」Microsoft Excel) 隨即出現。只建議在 SDI 應用程式的文件樣板。
- CDocTemplate::docName 支援預設檔案名稱 (例如，「工作表」)。這個根，加上數字，對於這個型別的新文件的預設名稱使用，在使用者從檔案功能表中選取新的命令 (例如，「Sheet1」或「Sheet2」)。如果未指定，「沒有權限」當做預設值使用。
- 這個資料型別的CDocTemplate::fileNewName 名稱。如果應用程式支援超過一種類型的文件，這個字串會在檔案中新的對話方塊 (例如，「右邊」) 會顯示。如果未指定，則資料型別使用檔案的新命令無法存取。
- 這個型別的資料型別和萬用字元篩選相符的資料CDocTemplate::filterName 的描述。這個字串中列出顯示型別在 [開啟舊檔] 對話方塊的下拉式清單 (例如，「工作表 (*.xls) ")。如果未指定，則資料型別會使用 [開啟舊檔] 命令無法存取。
- 這個型別的資料 (例如，「.xls」)CDocTemplate::filterExt 副檔名。如果未指定，則資料型別會使用 [開啟舊檔] 命令無法存取。
- 在系統註冊資料庫中儲存的資料型別的CDocTemplate::regFileTypeId 識別項維護由視窗。這個字串僅供內部使用 (例如，「ExcelWorksheet」)。如果未指定，則資料型別無法移至 Windows 檔案管理員註冊。
- 在系統註冊資料庫中儲存的資料型別的CDocTemplate::regFileTypeName 名稱。這個字串 (例如存取系統註冊資料庫的對話方塊會顯示應用程式 (例如，「Microsoft Excel 工作表」)。

傳回值

不是零，如果找不到指定的子字串;則為 0。

備註

呼叫此函式以取得描述資料型別的某個特定的子字串。包含這些子字串的字串在文件樣板中並從資源檔中的字串取得應用程式的。架構會呼叫它為應用程式的使用者介面需要此函式取得字串。如果您為應用程式的文件中指定的副檔名，架構也會呼叫這個函式，將項目加入 Windows 登入資料庫時，這可以讓文件檔案管理員從視窗隨即開啟。

只有當您從 CDocTemplate、衍生自訂類別，請呼叫此函式。