Share via


CLUSCTL_CLOUD_WITNESS_RESOURCE_UPDATE_TOKEN control code

Updates the token used to validate a set of credentials for an Cloud Witness resource. Applications use this control code as a ClusterResourceControl parameter.

ClusterResourceControl( 
  hResource,                       // resource handle
  hHostNode,                       // optional node handle
  CLUSCTL_CLOUD_WITNESS_RESOURCE_UPDATE_TOKEN,   // this control code
  lpInBuffer,                      // input buffer
  cbInBufferSize,                  // input buffer size (bytes)
  lpOutBuffer,                     // output buffer
  cbOutBufferSize,                 // output buffer size (bytes)
  lpcbBytesReturned );             // resulting data size (bytes)

Parameters

The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterResourceControl.

lpOutBuffer

On a successful return, points to a property list that contains the shared access signature (SAS) of the token.

Return value

ClusterResourceControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

ClusAPI.h defines the 32 bits of CLUSCTL_CLOUD_WITNESS_RESOURCE_UPDATE_TOKEN (0x014020E6) as follows (for more information, see Control Code Architecture).

Component Bit location Value
Object code 24 31 CLUS_OBJECT_RESOURCE (0x1)
Global bit 23 CLUS_NOT_GLOBAL (0x0)
Modify bit 22 CLUS_MODIFY (0x1)
User bit 21 CLCTL_CLUSTER_BASE (0x0)
Type bit 20 External (0x0)
Operation code 0 23 CLCTL_CLOUD_WITNESS_RESOURCE_UPDATE_TOKEN (0x4020E6)
Access code 0 1 CLUS_ACCESS_WRITE (0x2)

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2016
Header
ClusAPI.h

See also

External Resource Control Codes

Control Codes