Partilhar via


IDebugDocumentContext2::GetName

Obtém o nome de exibição do documento que contém nesse contexto de documento.

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

Parâmetros

  • gnType
    [in] Um valor a partir do GETNAME_TYPE enumeração que especifica o tipo de nome para retornar.

  • pbstrFileName
    [out] Retorna o nome do arquivo.

Valor de retorno

Se bem-sucedida, retorna S_OK; Caso contrário, retorna um código de erro.

Comentários

Este método geralmente encaminha a chamada para o IDebugDocument2::GetName método, a menos que o contexto do documento é gravado para armazenar o nome do documento propriamente dito (como a apresentação de exemplo).

Exemplo

O exemplo a seguir mostra como implementar este método para um simples CDebugContext objeto que expõe a 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;  
}  

Consulte também

Referência

IDebugDocumentContext2

GETNAME_TYPE