GetIdentity

The GetIdentity and GetIdentityWide methods return a string describing the computer and user this client represents.

HRESULT
  IDebugClient::GetIdentity(
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  IdentitySize
    );

HRESULT
  IDebugClient5::GetIdentityWide(
    OUT OPTIONAL PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  IdentitySize
    );

#ifdef UNICODE
#define GetIdentityT GetIdentityWide
#else
#define GetIdentityT GetIdentity
#endif

Parameters

Buffer

Specifies the buffer to receive the string. If Buffer is NULL, this information is not returned.

BufferSize

Specifies the size of the buffer Buffer.

IdentitySize

Receives the size of the string. If IdentitySize is NULL, this information is not returned.

Return Value

S_OK

The method was successful

S_FALSE

The size of the string was greater than the size of the buffer, so it was truncated to fit into the buffer.

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

Interface Version

GetIdentity is available in all versions of IDebugClient. GetIdentityWide 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

OutputIdentity