MprAdminInterfaceDeviceGetInfo function (mprapi.h)
The MprAdminInterfaceDeviceGetInfo retrieves information about a device that is used in a router demand-dial interface.
Syntax
DWORD MprAdminInterfaceDeviceGetInfo(
[in] MPR_SERVER_HANDLE hMprServer,
[in] HANDLE hInterface,
[in] DWORD dwIndex,
[in] DWORD dwLevel,
[out] LPBYTE *lplpBuffer
);
Parameters
[in] hMprServer
Handle to router on which to execute this call. Obtain this handle by calling MprAdminServerConnect.
[in] hInterface
Handle to the interface. Obtain this handle from a previous call to MprAdminInterfaceCreate, or by calling MprAdminInterfaceEnum
[in] dwIndex
Specifies the one-based index of the device. A multi-linked demand-dial interface uses multiple devices.
[in] dwLevel
A DWORD value that describes the format in which the information is returned in the lplpBuffer parameter. Acceptable values for dwLevel include 0 or 1 as listed in the following table.
| Value | Structure Format |
|---|---|
| 0 | MPR_DEVICE_0 |
| 1 | MPR_DEVICE_1 |
[out] lplpBuffer
On successful completion, a pointer to a MPR_DEVICE_0 or MPR_DEVICE_1 structure. The dwLevel parameter indicates the type of structure. Free this memory by calling MprAdminBufferFree.
Return value
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following error codes.
| Value | Meaning |
|---|---|
|
The calling application does not have sufficient privileges. |
|
The hInterface value is invalid. |
|
The lplpbBuffer parameter is NULL. |
|
Insufficient resources to complete the operation. |
|
The dwLevel value is invalid. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | mprapi.h |
| Library | Mprapi.lib |
| DLL | Mprapi.dll |