Edit

Share via

ITextDocument::GetName method (tom.h)

  • Article

Gets the file name of this document. This is the ITextDocument default property.

Syntax

HRESULT GetName(
  BSTR *pName
);

Parameters

pName

Type: BSTR*

The file name.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code Description
S_FALSE
 No file name associated with this object.
E_INVALIDARG
 Invalid argument.
E_OUTOFMEMORY
 Insufficient memory for output string.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

Conceptual

ITextDocument

Reference

Text Object Model