IDebugDocumentContext2::GetNameIDebugDocumentContext2::GetName

Obtiene el nombre del documento que contiene este contexto de documento que se pueden mostrar.Gets the displayable name of the document that contains this document context.

SintaxisSyntax

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

ParámetrosParameters

gnType
[in] Un valor de la GETNAME_TYPE enumeración que especifica el tipo de nombre para devolver.[in] A value from the GETNAME_TYPE enumeration that specifies the type of name to return.

pbstrFileName
[out] Devuelve el nombre del archivo.[out] Returns the name of the file.

Valor devueltoReturn Value

Si se realiza correctamente, devuelve S_OK; en caso contrario, devuelve un código de error.If successful, returns S_OK; otherwise, returns an error code.

ComentariosRemarks

Normalmente, este método reenvía la llamada a la GetName método, a menos que el contexto del documento está escrito para almacenar el nombre de documento (como el programa de ejemplo).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).

EjemploExample

En el ejemplo siguiente se muestra cómo implementar este método para un sencillo CDebugContext objeto que expone la IDebugDocumentContext2 interfaz.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;    
}    

Vea tambiénSee Also

IDebugDocumentContext2 IDebugDocumentContext2
GETNAME_TYPEGETNAME_TYPE