IDebugDocumentContext2:: GetName
Ottiene il nome visibile del documento contenente tale contesto del documento.
HRESULT GetName(
GETNAME_TYPE gnType,
BSTR* pbstrFileName
);
int GetName(
enum_GETNAME_TYPE gnType,
out string pbstrFileName
);
Parametri
gnType
[in] Un valore GETNAME_TYPE dell'enumerazione che specifica il tipo di nome per restituire.pbstrFileName
[out] Restituisce il nome del file.
Valore restituito
Se l'operazione riesce, restituisce S_OK; in caso contrario, restituisce un codice di errore.
Note
Questo metodo in genere inoltra la chiamata IDebugDocument2:: GetName al metodo, a meno che il contesto del documento venga scritto per archiviare il nome stesso del documento (come mostrano di esempio).
Esempio
Nell'esempio seguente viene illustrato come implementare questo metodo per un oggetto semplice di CDebugContext che espone IDebugDocumentContext2 l'interfaccia.
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;
}