IDebugDocumentContext2::GetName

Artículo
01/12/2024

Obtiene el nombre que se puede mostrar del documento que contiene este contexto de documento.

Sintaxis

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

HRESULT GetName(
    GETNAME_TYPE gnType,
    BSTR*        pbstrFileName
);

Parámetros

gnType
[in] Valor de la enumeración GETNAME_TYPE que especifica el tipo de nombre que se va a devolver.

pbstrFileName
[out] Devuelve el nombre del archivo.

Valor devuelto

Si la operación se realiza correctamente, devuelve S_OK; de lo contrario, devuelve un código de error.

Comentarios

Este método normalmente reenvía la llamada al método GetName , a menos que el contexto del documento se escriba para almacenar el propio nombre del documento (como se muestra en el ejemplo).

Ejemplo

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