IDebugDocumentContext2::GetName

Artigo
01/12/2024

Obtém o nome exibível do documento que contém esse contexto de documento.

Sintaxe

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

HRESULT GetName(
    GETNAME_TYPE gnType,
    BSTR*        pbstrFileName
);

Parâmetros

gnType
[em] Um valor da enumeração GETNAME_TYPE que especifica o tipo de nome a ser retornado.

pbstrFileName
[saiu] Retorna o nome do arquivo.

Valor de retorno

Se tiver êxito, retornará S_OK. Caso contrário, retornará um código de erro.

Comentários

Esse método normalmente encaminha a chamada para o método GetName, a menos que o contexto do documento seja gravado para armazenar o próprio nome do documento (como mostra o exemplo).

Exemplo

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