State Property

Opaque value used to maintain state between the request and response.

Syntax

ANSI (Cross Platform)
char* GetState();
int SetState(const char* lpszState);

Unicode (Windows)
LPWSTR GetState();
INT SetState(LPCWSTR lpszState);
@property (nonatomic,readwrite,assign,getter=state,setter=setState:) NSString* state;
- (NSString*)state;
- (void)setState:(NSString*)newState;

#define PID_OPENID_STATE 67

IPWORKSAUTH_EXTERNAL void* IPWORKSAUTH_CALL IPWorksAuth_OpenID_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSAUTH_EXTERNAL int IPWORKSAUTH_CALL IPWorksAuth_OpenID_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

This property optionally holds a string value which will be returned by the authorization server with the response.

Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value.

When ClientProfile is set to cfApplication the ReturnURL event provides the state value returned by the authorization server.

Data Type

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