Freigeben über


IDebugDocumentContext2::GetName

Ruft den anzeigbaren Namen des Dokuments ab, das den Dokumentenkontext enthält.

HRESULT GetName( 
   GETNAME_TYPE gnType,
   BSTR*        pbstrFileName
);
int GetName( 
   enum_GETNAME_TYPE  gnType,
   out string         pbstrFileName
);

Parameter

  • gnType
    [in] Ein Wert aus der GETNAME_TYPE-Enumeration, der den Typ des Namens angibt, die zurückgegeben werden soll.

  • pbstrFileName
    [out] Gibt den Namen der Datei zurück.

Rückgabewert

Bei Erfolg gibt S_OKzurück. andernfalls gibt einen Fehlercode zurück.

Hinweise

Diese Methode wird i. d. R. den Aufruf an die IDebugDocument2::GetName-Methode weitergegeben, sofern der Dokumentenkontext geschrieben wird, um den Dokumentnamen selbst zu speichern (als Beispielen werden).

Beispiel

Im folgenden Beispiel wird veranschaulicht, wie diese Methode für ein einfaches CDebugContext-Objekt implementiert, das die IDebugDocumentContext2-Schnittstelle verfügbar macht.

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;  
}  

Siehe auch

Referenz

IDebugDocumentContext2

GETNAME_TYPE