Edit

Share via

ITAgentSession::get_Agent method (tapi3.h)

  • Article

The get_Agent method gets a pointer to the ITAgent interface associated with this session.

Syntax

HRESULT get_Agent(
  [out] ITAgent **ppAgent
);

Parameters

[out] ppAgent

pointer to ITAgent interface.

Return value

This method can return one of these values.

Value Meaning
S_OK
 Method succeeded.
E_OUTOFMEMORY
 Insufficient memory exists to perform the operation.
E_POINTER
 The ppAgent parameter is not a valid pointer.

Remarks

TAPI calls the AddRef method on the ITAgent interface returned by ITAgentSession::get_Agent. The application must call Release on the ITAgent interface to free resources associated with it.

Requirements

Requirement Value
Target Platform Windows
Header tapi3.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ITAgent

ITAgentSession