IDebugDocumentContext2::GetName

Articolo
01/12/2024

Ottiene il nome visualizzato del documento che contiene il contesto del documento.

Sintassi

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

HRESULT GetName(
    GETNAME_TYPE gnType,
    BSTR*        pbstrFileName
);

Parametri

gnType
[in] Valore dell'enumerazione GETNAME_TYPE che specifica il tipo di nome da restituire.

pbstrFileName
[out] Restituisce il nome del file.

Valore restituito

Se ha esito positivo, restituisce S_OK; in caso contrario, restituisce un codice di errore.

Osservazioni:

Questo metodo in genere inoltra la chiamata al metodo GetName , a meno che il contesto del documento non venga scritto per archiviare il nome del documento stesso (come illustrato nell'esempio).

Esempio

Nell'esempio seguente viene illustrato come implementare questo metodo per un oggetto semplice CDebugContext che espone l'interfaccia 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;
}

Condividi tramite