IDebugClient5::OutputIdentity method (dbgeng.h)

The OutputIdentity method formats and outputs a string describing the computer and user this client represents.

Syntax

HRESULT OutputIdentity(
  [in] ULONG OutputControl,
  [in] ULONG Flags,
  [in] PCSTR Format
);

Parameters

[in] OutputControl

Specifies where to send the output. For possible values, see DEBUG_OUTCTL_XXX.

[in] Flags

Set to zero.

[in] Format

Specifies a format string similar to the printf format string. However, this format string must only contain one formatting directive, %s, which will be replaced by a description of the computer and user this client represents.

Return value

This method may also return error values. See Return Values for more details.

Return code Description
S_OK
The method was successful.

Remarks

The specific content of the string varies with the operating system. If the client is remotely connected, some network information may also be present.

For more information about client objects, see Client Objects.

Requirements

Requirement Value
Target Platform Desktop
Header dbgeng.h (include Dbgeng.h)

See also

GetIdentity

IDebugClient

IDebugClient2

IDebugClient3

IDebugClient4

IDebugClient5