Udostępnij za pośrednictwem

IDebugDocumentContext2::GetName

  • Artykuł

Pobiera wyświetlaną nazwę dokumentu zawierającego ten kontekst dokumentu.

Składnia

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

Parametry

gnType
[in] Wartość z wyliczenia GETNAME_TYPE , która określa typ nazwy do zwrócenia.

pbstrFileName
[out] Zwraca nazwę pliku.

Wartość zwracana

Jeśli operacja powiedzie się, zwraca wartość S_OK; w przeciwnym razie zwraca kod błędu.

Uwagi

Ta metoda zwykle przekazuje wywołanie metody GetName , chyba że kontekst dokumentu jest zapisywany w celu przechowywania samej nazwy dokumentu (jak pokazano w przykładzie).

Przykład

W poniższym przykładzie pokazano, jak zaimplementować tę metodę dla prostego CDebugContext obiektu, który uwidacznia interfejs 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;
}

Zobacz też