3.1.4.44 RMprAdminServerSetInfo (Opnum 43)

  • Article

The RMprAdminServerSetInfo method<316> sets ports information on a specified server hDimServer.

 DWORD RMprAdminServerSetInfo(
   [in] DIM_HANDLE hDimServer,
   [in] DWORD dwLevel,
   [in] PDIM_INFORMATION_CONTAINER pInfoStruct
 );

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

dwLevel: This is of type DWORD and MUST be set to any of the following values.

Value

Meaning

1

pInfoStruct->pBuffer MUST be a pointer to a MPR_SERVER_1 (section 2.2.1.2.62).

2

pInfoStruct->pBuffer MUST be a pointer to a MPR_SERVER_2 (section 2.2.1.2.63).

pInfoStruct: This is a pointer of type PDIM_INFORMATION_CONTAINER (section 2.2.1.2.1) and MUST be set to the following, based on dwLevel.

dwLevel

pInfoStruct->size

pInfoStruct->pBuffer

1

This MUST be set to the size of MPR_SERVER_1 (section 2.2.1.2.62).

This MUST be set to a pointer to a MPR_SERVER_1 (section 2.2.1.2.62).

2

This MUST be set to the size of MPR_SERVER_2 (section 2.2.1.2.63).

This MUST be set to a pointer to a MPR_SERVER_2 (section 2.2.1.2.63).

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 listed 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.

ERROR_SUCCESS_REBOOT_REQUIRED

0x00000BC2

A system reboot is required for such a change to take effect.<317>

The opnum field value for this method is 43.

When processing this call, the RRASM server MUST do the following:

  • Validate, as specified in 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.

  • If pInfoStruct is NULL, return an error other than those in the preceding table.

  • If dwLevel is not supported, return an error other than one of the errors listed 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 completes the processing successfully return either ERROR_SUCCESS or ERROR_SUCCESS_REBOOT_REQUIRED<318> based on the impact of the configuration change as indicated by the RRAS server. Otherwise return the error status.

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