IPWorks WebSockets 2020 C++ Edition

Questions / Feedback?

Origin Property

The Origin header field value.

Syntax

ANSI (Cross Platform)
char* GetOrigin();
int SetOrigin(const char* lpszOrigin); Unicode (Windows) LPWSTR GetOrigin();
INT SetOrigin(LPCWSTR lpszOrigin);
@property (nonatomic,readwrite,assign,getter=origin,setter=setOrigin:) NSString* origin;
- (NSString*)origin;
- (void)setOrigin:(NSString*)newOrigin;
#define PID_WEBSOCKETCLIENT_ORIGIN 24

IPWORKSWS_EXTERNAL void* IPWORKSWS_CALL IPWorksWS_WebSocketClient_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSWS_EXTERNAL int IPWORKSWS_CALL IPWorksWS_WebSocketClient_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

If specified, the class will include an Origin HTTP header in the connection request with the value provided. Servers may use this value to validate requests. Servers may reject requests depending on the value provided.

A typical value that would be set is of the form "http://example.com".

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 C++ Edition - Version 20.0 [Build 8155]