WebSocketConnectionSubProtocols Property

The subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetWebSocketConnectionSubProtocols(int iConnectionId);

Unicode (Windows)
LPWSTR GetWebSocketConnectionSubProtocols(INT iConnectionId);

- (NSString*)webSocketConnectionSubProtocols:(int)connectionId;

#define PID_WEBSOCKETSERVER_WEBSOCKETCONNECTIONSUBPROTOCOLS 17

IPWORKSWS_EXTERNAL void* IPWORKSWS_CALL IPWorksWS_WebSocketServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

IPWORKSWS_EXTERNAL int IPWORKSWS_CALL IPWorksWS_WebSocketServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

""

Remarks

The subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WebSocketConnectionCount property.

This property is read-only and not available at design time.

Data Type

String