IDebugDocumentContext2::GetNameIDebugDocumentContext2::GetName

Obtient le nom complet du document qui contient le contexte de ce document.Gets the displayable name of the document that contains this document context.

SyntaxeSyntax

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

ParamètresParameters

gnType
[in] Une valeur à partir de la GETNAME_TYPE énumération qui spécifie le type de nom à retourner.[in] A value from the GETNAME_TYPE enumeration that specifies the type of name to return.

pbstrFileName
[out] Retourne le nom du fichier.[out] Returns the name of the file.

Valeur de retourReturn Value

En cas de réussite, retourne S_OK; sinon, retourne un code d’erreur.If successful, returns S_OK; otherwise, returns an error code.

NotesRemarks

Cette méthode transfère en général, l’appel à la GetName (méthode), sauf si le contexte de document est écrites pour stocker le nom du document (comme le montrent les exemple).This method typically forwards the call to the GetName method, unless the document context is written to store the document name itself (as the Example show).

ExempleExample

L’exemple suivant montre comment implémenter cette méthode pour une simple CDebugContext objet qui expose la IDebugDocumentContext2 interface.The following example shows how to implement this method for a simple CDebugContext object that exposes the IDebugDocumentContext2 interface.

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

Voir aussiSee Also

IDebugDocumentContext2 IDebugDocumentContext2
GETNAME_TYPEGETNAME_TYPE