3.3.4.2 RasRpcGetUserPreferences (Opnum 9)

  • Article

The RasRpcGetUserPreferences method retrieves the configuration information. The configuration information consists of the callback information associated with the various ports, and the number of the last successful callback done by the RRAS. This configuration information is set by RasRpcSetUserPreferences (section 3.3.4.3). 

 DWORD RasRpcGetUserPreferences(
   [in] handle_t h,
   [in, out] LPRASRPC_PBUSER pUser,
   [in] DWORD dwMode
 );

h: An RPC binding handle as specified in [C706] section 2.

pUser: Pointer to the RASRPC_PBUSER (section 2.2.1.2.229) structure which on successful return contains the configuration information on the RRAS server.

dwMode: This MUST be set to 2.

Return Values: Specifies the return status as explained in section 2.2.1.2.218 for the retcode field.

The return value can be one of the following error codes. All other error values MUST be treated the same by the RRASM client.

Return value/code

Description

ERROR_SUCCESS

0x00000000

The call was successful.

Exceptions Thrown: This method throws an exception with the exception code RPC_S_ACCESS_DENIED (0x00000005) if the client is not an administrator on the RRASM server, with access permission to perform the operation.<335>

The Opnum field value for this method is 9.

When processing this call, the RRASM SHOULD do the following:

  • Validate as specified in section 3.3.4 whether this method was called by a client that is an administrator of the RRASM server.<336>

  • Call the abstract interface Invoke RASRPC method, specifying the operation and the parameters necessary to enable RRAS server to perform the required management task.

  • Populate the pUser structure with the configuration information returned by the RRAS server and returning ERROR_SUCCESS (0x00000000).