| INT GetBearerToken( |
| |
LPTSTR lpszBearerToken, |
|
| |
INT nMaxLength |
|
| ); |
| INT GetBearerToken( |
| |
CString& strBearerToken |
|
| ); |
The GetBearerToken method returns the OAuth 2.0 bearer
token used to authenticate the client session with a web service.
Parameters
- lpszBearerToken
- A pointer to a string buffer which will contain the bearer
token when the method returns. The string will be null terminated
and the the buffer must be large enough to accommodate the
entire bearer token or the method will fail. This parameter cannot
be a NULL pointer. An alternate version of this method accepts a
CString object.
- nMaxLength
- The maximum number of characters that may be copied into the
string buffer. This value must be greater than zero.
Return Value
If the method succeeds, the return value is the length of the
bearer token string. A return value of zero indicates that no bearer
token has been specified. If the method fails, the return value is
HTTP_ERROR. To get extended error information, call GetLastError.
Remarks
This method returns the bearer token which was previously set by
a call to SetBearerToken. Bearer tokens can be
very long strings and do not contain any human readable information.
For Google services, these tokens are usually about 180 characters in
length. For Microsoft services, their bearer tokens are typically
1,200 characters in length. It is recommended that you provide a
buffer size of at least 2,000 characters.
Your application should not store the bearer tokens provided by a
web service. These tokens are short-lived and typically only valid
for about an hour. If the token has expired, the authorization to
access the resource will fail and it must be refreshed. The
refresh tokens used to acquire a new bearer token should be stored and
they are typically valid for a period of months.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools11.h
Import Library: cshtpv11.lib
Unicode: Implemented as Unicode and ANSI versions
See Also
Authenticate,
SetBearerToken
|