IDebugDocumentHelper::Init

  • Article

The Init method initializes a debug document helper with a name and initial attributes.

Syntax

HRESULT Init(  
   IDebugApplication*  pda,  
   LPCOLESTR           pszShortName,  
   LPCOLESTR           pszLongName,  
   TEXT_DOC_ATTR       docAttr  
);

Parameters

pda
[in] The debug application associated with this document.

pszShortName
[in] A null-terminated string containing the short name of the document.

pszLongName
[in] A null-terminated string containing the long name of the document.

docAttr
[in] Specifies text document attributes.

Return Value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Value Description
S_OK The method succeeded.

Remarks

This method initializes a debug document helper with a name and initial attributes.

This document does not appear in the tree until IDebugDocumentHelper::Attach is called.

See also

IDebugDocumentHelper::Attach
IDebugDocumentHelper Interface
TEXT_DOC_ATTR Constants