IDebugDocumentContext2::GetName

  • 项目

获取包含此文档上下文的文档的可显示名称。

语法

int GetName(
    enum_GETNAME_TYPE  gnType,
    out string         pbstrFileName
);

参数

gnType
[in]GETNAME_TYPE枚举中的一个值，指定要返回的名称类型。

pbstrFileName
[out]返回文件的名称。

返回值

如果成功，则返回 S_OK；否则，返回错误代码。

备注

此方法通常将调用转发到 GetName 方法，除非写入文档上下文来存储文档名称本身（如示例所示）。

示例

以下示例演示如何为公开 IDebugDocumentContext2 接口的简单CDebugContext对象实现此方法。

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

另请参阅