OutputIdentity

The OutputIdentity and OutputIdentityWide methods format and output a string describing the computer and user this client represents.

HRESULT
  IDebugClient::OutputIdentity(
    IN ULONG  OutputControl,
    IN ULONG  Flags,
    IN PCSTR  Format
    );

HRESULT
  IDebugClient5::OutputIdentityWide(
    IN ULONG  OutputControl,
    IN ULONG  Flags,
    IN PCWSTR  Format
    );

#ifdef UNICODE
#define OutputIdentityT OutputIdentityWide
#else
#define OutputIdentityT OutputIdentity
#endif

Parameters

OutputControl

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

Flags

Set to zero.

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

S_OK

The method was successful.

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

Interface Version

OutputIdentity is available in all versions of IDebugClient. OutputIdentityWide is available in IDebugClient5 and later versions.

Comments

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

Headers: Defined in dbgeng.h. Include dbgeng.h.

See Also

GetIdentity