IDebugDocumentContext2::GetName

Article
01/12/2024

Obtient le nom affichable du document qui contient ce contexte de document.

Syntaxe

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

HRESULT GetName(
    GETNAME_TYPE gnType,
    BSTR*        pbstrFileName
);

Paramètres

gnType
[in] Valeur de l’énumération GETNAME_TYPE qui spécifie le type de nom à retourner.

pbstrFileName
[out] Retourne le nom du fichier.

Valeur de retour

En cas de réussite, retourne S_OK , sinon, retourne un code d'erreur.

Notes

Cette méthode transfère généralement l’appel à la méthode GetName , sauf si le contexte du document est écrit pour stocker le nom du document lui-même (comme l’illustre l’exemple).

Exemple

L’exemple suivant montre comment implémenter cette méthode pour un objet simple CDebugContext qui expose l’interface 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;
}