The RRouterInterfaceDeviceGetInfo method<309> retrieves information for a specified device, dwIndex, for a specified interface hInterface, on a specified server, hDimServer.
DWORD RRouterInterfaceDeviceGetInfo( [in] DIM_HANDLE hDimServer, [in] DWORD dwLevel, [in, out] PDIM_INFORMATION_CONTAINER pInfoStruct, [in] DWORD dwIndex, [in] DWORD hInterface );
hDimServer: A handle to the RRASM server where the call is executed, see section 3.1.3.
dwLevel: This is of type DWORD and MUST be set to any of the following values.
|
Value |
Meaning |
|---|---|
|
0 |
After the function returns, the memory pointed to by pInfoStruct->pBuffer is interpreted as MPR_DEVICE_0 (section 2.2.1.2.85). |
|
1 |
After the function returns, the memory pointed to by pInfoStruct->pBuffer is interpreted as MPR_DEVICE_1 (section 2.2.1.2.86). |
pInfoStruct: This is a pointer of type DIM_INFORMATION_CONTAINER (section 2.2.1.2.1) and pInfoStruct.dwBufferSize SHOULD be initialized to zero (0). Upon successful return, the pInfoStruct->pBuffer is a typecast array of MPR_DEVICE_0 (section 2.2.1.2.85) or MPR_DEVICE_1 (section 2.2.1.2.86), based on the dwLevel value.
dwIndex: Specifies the one-based index of the device. A multilinked demand-dial interface uses multiple devices.
hInterface: The unique identifier of an interface. This can be obtained from RRouterInterfaceCreate (section 3.1.4.13) or RRouterInterfaceGetHandle (section 3.1.4.12). Since the RRASM server does not maintain interface handles, the RRAS server SHOULD check and ensure that this handle represents a valid interface handle.
Return Values: A 32-bit, unsigned integer value that indicates return status. A return value of ERROR_SUCCESS (0x00000000) indicates that the operation was completed successfully; otherwise, the return value contains an error code, as specified in [MS-ERREF] or in section 2.2.4. All values not in the following table MUST be treated the same by the RRASM client.
|
Return value/code |
Description |
|---|---|
|
ERROR_SUCCESS 0x00000000 |
The call was successful. |
|
ERROR_ACCESS_DENIED 0x00000005 |
The calling application does not have sufficient privileges. |
The opnum field value for this method is 38.
When processing this call, the RRASM server MUST do the following:
Validate, as specified in section 2.1.1.1, whether this method was called by a client that has access to the method. If the client does not have access, then return error ERROR_ACCESS_DENIED (0x00000005).
If pInfoStruct is NULL, return an error other than those in the preceding table.
If dwLevel is not supported, return an error other than those in the preceding table.
Call the abstract interface Invoke DIMSVC method specifying the operation and the parameters to enable RRAS server to perform the required management task.
If the RRAS server successfully processes the request, fill the returned information in pInfoStruct and return ERROR_SUCCESS (0x00000000). Otherwise return the ERROR_STATUS returned by the RRAS server.
No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].