Share via

IDebugMessageEvent2::GetMessage

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Gets the message to be displayed.

Syntax

HRESULT GetMessage( 
   MESSAGETYPE* pMessageType,
   BSTR*        pbstrMessage,
   DWORD*       pdwType,
   BSTR*        pbstrHelpFileName,
   DWORD*       pdwHelpId
);

int GetMessage( 
   out enum_MESSAGETYPE pMessageType,
   out string           pbstrMessage,
   out uint             pdwType,
   out string           pbstrHelpFileName,
   out uint             dwHelpId
);

Parameters

pMessageType
[out] Returns a value from the MESSAGETYPE enumeration that describes the type of the message.

pbstrMessage
[out] Returns the message.

pdwType
[out] Returns the type of the message, using the conventions of the Win32 MessageBox function. See the AfxMessageBox function for details.

pbstrHelpFileName
[in, out] Returns the help file name. May be a null (C++) or empty (C#) value if there is no help file.

pdwHelpId
[in, out] Returns the help identifier. May be 0 if there is no help associated with this message.

Return Value

If successful, returns S_OK; otherwise, returns an error code.

See also