Open topic with navigation
SK_SOLO_NetworkSessionCheckoutGetRequest Function
Builds a request to send to the XmlNetworkFloatingService web service's CheckoutSession method in SOLO Server.
The XML document returned in the request parameter must be freed from memory! The SK_XmlDocumentDispose function is recommended for this purpose.
Syntax
- C/C++
- SK_ResultCode SK_SOLO_NetworkSessionCheckoutGetRequest(SK_ApiContext context, int flags, const char *sessionId, const char *certificatePath, double requestedCheckoutDuration, SK_XmlDoc *request, char **sessionCode);
- Visual Basic
- Declare Function SK_SOLO_NetworkSessionCheckoutGetRequest(ByVal context As Long, ByVal flags As Long, ByVal sessionId As String, ByVal certificatePath As String, ByVal requestedCheckoutDuration As Long, ByRef request As Long, ByRef sessionCode As String) As Long
Arguments
- context
- The API Context handle.
- flags
- Any flags passed into this function-call.
- sessionId
- The Session ID issued by SOLO Server.
- certificatePath
- The absolute path to the Network Session Certificate file.
- requestedCheckoutDuration
- The amount of time (in hours) we would like the requested checkout to last.
- request
- Reference/pointer to a SK_XmlDoc handle, which will point to the XML document handle that contains the request when the call succeeds. The handle must be initialized to NULL (0) prior to calling this function.
- sessionCode
- Reference/pointer to a string pointer, which will point to the string which contains the unique session code generated for this request when the call succeeds. The string pointer must be initialized to NULL (0) prior to calling this function.
Returns
All possible return values are included in the SK_ResultCode enumeration. Return codes to expect include: