Share via

2.2.9.2.1.9.1.1 TSG_PACKET_STRING_MESSAGE

  • Article

The TSG_PACKET_STRING_MESSAGE structure contains either the Consent Signing Message or the Administrative Message that is being sent from the RDG server to the client.

 typedef struct _TSG_PACKET_STRING_MESSAGE {
   long isDisplayMandatory;
   long isConsentMandatory;
   [range(0,65536)] unsigned long msgBytes;
   [size_is(msgBytes)] wchar_t* msgBuffer;
 } TSG_PACKET_STRING_MESSAGE,
  *PTSG_PACKET_STRING_MESSAGE;

isDisplayMandatory: A Boolean that specifies whether the client needs to display this message.

isConsentMandatory: A Boolean that specifies whether the user needs to give its consent before the connection can proceed.

msgBytes: An unsigned long specifying the number of characters in msgBuffer, including the terminating null character. The size of the message SHOULD<21> be determined by the serverCert field in the HTTP_TUNNEL_RESPONSE_OPTIONAL structure (section 2.2.10.21). The consent message is embedded in the HTTP_TUNNEL_RESPONSE as part of the HTTP_TUNNEL_RESPONSE_OPTIONAL structure. When the HTTP_TUNNEL_RESPONSE_FIELD_CONSENT_MSG flag is set in the HTTP_TUNNEL_RESPONSE_FIELDS_PRESENT_FLAGS (section 2.2.5.3.8), the HTTP_TUNNEL_RESPONSE_OPTIONAL data structure contains a consent message in the HTTP_UNICODE_STRING format (section 2.2.10.22).

msgBuffer: An array of wchar_t specifying the string. The size of the buffer is as indicated by msgBytes.