IDebugDocumentContext2::GetName

Bu belge bağlamını içeren belgenin görüntülenebilir adını alır.

Sözdizimi

C#

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

C++

HRESULT GetName(
    GETNAME_TYPE gnType,
    BSTR*        pbstrFileName
);

Parametreler

gnType
[in] döndürülecek ad türünü belirten GETNAME_TYPE numaralandırmasından bir değer.

pbstrFileName
[out] Dosyanın adını döndürür.

İade Değeri

Başarılı olursa döndürür S_OK; aksi takdirde bir hata kodu döndürür.

Açıklamalar

Bu yöntem, belge bağlamı belge adının kendisini depolamak için yazılmamışsa çağrıyı genellikle GetName yöntemine iletir (Örnek gösterildiği gibi).

Örnek

Aşağıdaki örnek, IDebugDocumentContext2 arabirimini kullanıma sunan basit CDebugContext bir nesne için bu yöntemin nasıl uygulandığını gösterir.

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

Ayrıca bkz.

• IDebugDocumentContext2
• GETNAME_TYPE