3.1.4.2.118 ApiOpenGroupEx (Opnum 119)

(Protocol Version 3) The ApiOpenGroupEx method SHOULD<98> establish context on the server about the interaction of a client with a specified cluster group by means of the current RPC connection. ApiOpenGroupEx returns a context handle so that the client can refer to the group in subsequent method calls.

The server MUST determine the level of access to be granted to the client (section 3.1.4). Upon success, the server MUST associate that level of access with the group context it has established.

The client has two ways to determine the group name to specify for the lpszGroupName parameter. A group can have a well-known name if it was configured as such using implementation-specific methods between servers. Alternatively, a client can use ApiGetResourceState which returns the name of the group in which a resource is contained.

The server SHOULD accept an ApiOpenGroupEx request if its protocol server state is read-only and MUST accept the request for processing if it is in the read/write state, as specified in section 3.1.1.

 HGROUP_RPC ApiOpenGroupEx(
   [in, string] LPCWSTR lpszGroupName,
   [in] DWORD dwDesiredAccess,
   [out] DWORD * lpdwGrantedAccess,
   [out] error_status_t *Status,
   [out] error_status_t *rpc_status
 );

lpszGroupName: A Unicode string that contains the name of the group for which to establish context on the server.

dwDesiredAccess: The value for this parameter is the same as specified for dwDesiredAccess in ApiOpenClusterEx.

lpdwGrantedAccess: The value for this parameter is the same as specified for lpdwGrantedAccess in ApiOpenClusterEx, with the additional stipulation that if the server sets lpdwGrantedAccess to GENERIC_READ and if the client has the backup privilege, as defined in [MS-LSAD], then the returned context handle can also be used in a subsequent call to ApiMoveGroup or ApiMoveGroupToNode.

Status: Indicates the status of this operation. The server MUST set Status to the following error codes for the specified conditions.

Value	Meaning
ERROR_SUCCESS 0x00000000	Success.
ERROR_ACCESS_DENIED 0x00000005	dwDesiredAccess indicates a level of access exceeding what the client is entitled to (section 3.1.4).
ERROR_SHARING_PAUSED 0x00000046	The remote server has been paused or is in the process of being started.
ERROR_INVALID_PARAMETER 0x00000057	dwDesiredAccess is invalid, as specified earlier in this section.
RPC_S_PROCNUM_OUT_OF_RANGE 0x000006D1	The server does not support this method.
ERROR_GROUP_NOT_FOUND 0x00001395	A group that matches the name lpszGroupName was not found in the cluster configuration.

For any other condition, the server sets Status to a value that is not one of the values listed in the preceding table. The client MUST treat all values that are not listed in the preceding table the same, except as specified in section 3.2.4.6.

rpc_status: A 32-bit integer used to indicate success or failure. The RPC runtime MUST indicate, by writing to this parameter, whether it succeeded in executing this method on the server. The encoding of the value passed in this parameter MUST conform to encoding for comm_status and fault_status, as specified in Appendix E of [C706].

Return Values: The method MUST return a valid HGROUP_RPC context handle (section 2.2.1.3) to indicate success; otherwise, it MUST return NULL.