ITAgent::get_ID method (tapi3.h)
The get_ID method gets an agent's ID.
Syntax
HRESULT get_ID(
[out] BSTR *ppID
);
Parameters
[out] ppID
Pointer to BSTR containing agent ID.
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
|
Method succeeded. |
|
ITAgent was not created using ITAgentHandler::CreateAgentWithID, but with ITAgentHandler::CreateAgent. No ID exists. |
|
The ppID parameter is not a valid pointer. |
|
Insufficient memory exists to perform the operation. |
Remarks
This method is provided for interfacing with legacy switch solutions.
The application must free the memory allocated for the ppID parameter through SysFreeString when the variable is no longer needed.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | tapi3.h (include Tapi3.h) |
| Library | Uuid.lib |
| DLL | Tapi3.dll |