IDebugDocumentContext2::GetName

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件。

取得包含此文件內容的文件可顯示名稱。

語法

HRESULT GetName(   
   GETNAME_TYPE gnType,  
   BSTR*        pbstrFileName  
);  

int GetName(   
   enum_GETNAME_TYPE  gnType,  
   out string         pbstrFileName  
);  

參數

gnType
[in]介於GETNAME_TYPE列舉，指定要傳回名稱的類型。

pbstrFileName
[out]傳回檔案的名稱。

傳回值

如果成功，傳回S_OK; 否則傳回錯誤碼。

備註

這個方法通常會轉送到呼叫GetName方法，除非寫入文件內容儲存文件名稱 （如範例中顯示）。

範例

下列範例示範如何實作這種簡單的方式CDebugContext公開物件IDebugDocumentContext2介面。

HRESULT CDebugContext::GetName(GETNAME_TYPE gnType, BSTR* pbstrFileName)    
{    
   HRESULT hr;    
  
   // Check for a valid file name argument.    
   if (pbstrFileName)    
   {    
      *pbstrFileName = NULL;    
  
      switch (gnType)    
      {    
         case GN_NAME:    
         case GN_FILENAME:    
         {    
            // Copy the member file name into the local file name.    
            *pbstrFileName = SysAllocString(m_sbstrFileName);    
            // Check for successful copy.    
            hr = (*pbstrFileName) ? S_OK : E_OUTOFMEMORY;    
            break;    
         }    
         default:    
         {    
            hr = E_FAIL;    
            break;    
         }    
      }    
   }    
   else    
   {    
      hr = E_INVALIDARG;    
   }    
  
   return hr;    
}    

另請參閱

IDebugDocumentContext2
GETNAME_TYPE