IDebugDocumentContext2::GetName

Článek
01/12/2024

Získá zobrazovaný název dokumentu, který obsahuje tento kontext dokumentu.

Syntaxe

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

HRESULT GetName(
    GETNAME_TYPE gnType,
    BSTR*        pbstrFileName
);

Parametry

gnType
[v] Hodnota z GETNAME_TYPE výčtu, která určuje typ názvu, který se má vrátit.

pbstrFileName
[ven] Vrátí název souboru.

Vrácená hodnota

V případě úspěchu vrátí hodnotu S_OK; v opačném případě vrátí kód chyby.

Poznámky

Tato metoda obvykle přesměruje volání metody GetName , pokud není zapisovaný kontext dokumentu k uložení samotného názvu dokumentu (jak ukazuje příklad).

Příklad

Následující příklad ukazuje, jak implementovat tuto metodu pro jednoduchý CDebugContext objekt, který zveřejňuje IDebugDocumentContext2 rozhraní.

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

Sdílet prostřednictvím