Edit

RPC_C_OPT_COOKIE_AUTH_DESCRIPTOR structure (rpcdcep.h)

  • Article

The RPC_C_OPT_COOKIE_AUTH_DESCRIPTOR structure contains a cookie that is inserted into the header of RPC/HTTP traffic. This cookie can be used for authentication or for load balancing. When used for authentication, RPC_S_COOKIE_AUTH_FAILED is returned from an RPC call if cookie authentication fails. There are no specific error messages when used for load balancing.

Syntax

typedef struct _RPC_C_OPT_COOKIE_AUTH_DESCRIPTOR {
  unsigned long BufferSize;
  char          *Buffer;
} RPC_C_OPT_COOKIE_AUTH_DESCRIPTOR;

Members

BufferSize

The length, in bytes, of Buffer.

Buffer

A null-terminated string that contains the cookie.

Remarks

A pointer to this structure is passed as the OptionValue when making a call to RpcBindingSetOption with RPC_C_OPT_COOKIE_AUTH as the option.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header rpcdcep.h (include Rpc.h)