3.1.4.36 RRasAdminSendUserMessage (Opnum 35)

  • Article

The RRasAdminSendUserMessage method<303> sends a message to the user connected on the connection specified by hDimServer.<304>

 DWORD RRasAdminSendUserMessage(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD hDimConnection,
   [in, string] LPWSTR lpwszMessage
 );

hDimServer: A handle to the RRASM server where the call is to be executed, see section 3.1.3.

hDimConnection: This is of type DWORD and MUST be set to a particular connection identifier for which the connection information is required. Obtain this handle by calling RRasAdminConnectionEnum (section 3.1.4.2). Since RRASM server does not maintain the connection handles, the RRAS server SHOULD check and ensure that this handle represents a valid interface handle.  

lpwszMessage: A pointer to a Unicode string that specifies the message to the user. It MUST NOT be NULL.

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 value contains an error code, as specified in [MS-ERREF] or in section 2.2.4. All values that are not in the table that follows 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 35.

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 RouterType is ROUTER_TYPE_LAN, return an error other than those specified in the preceding table.

  • If lpwszMessage is NULL, return an error other than one of the errors specified 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.

  • Return any error status the RRAS server might return while processing the request. Otherwise return ERROR_SUCCESS (0x00000000).

No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].