Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

DataFlex Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(DataFlex) SharePoint -- Check Out a File (or Undo a Checkout)

In SharePoint, you can check out a file to make sure nobody can change it before you update it. After updating, you can check in the file. This example shows how to check out a SharePoint file.

Note: To undo a checkout, replace the string "checkout" with "undocheckout" in the line of code that sets the request's path.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Variant vReq
    Handle hoReq
    Boolean iBUseTls
    Variant vResp
    Handle hoResp
    Handle hoXml
    Boolean iSuccess
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // If SharePoint Windows classic authentication is used, then set the 
    // Login, Password, LoginDomain, and NtlmAuth properties.
    Set ComLogin Of hoHttp To "SHAREPOINT_USERNAME"
    Set ComPassword Of hoHttp To "SHAREPOINT_PASSWORD"
    Set ComLoginDomain Of hoHttp To "SHAREPOINT_NTLM_DOMAIN"
    Set ComNtlmAuth Of hoHttp To True

    // The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
    // If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
    // establish the cookie as shown at SharePoint Online Authentication

    // The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
    // If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
    // establish the cookie as shown at SharePoint Online Authentication

    // This example will check out the file named "penguins2.jpg" 
    // which is located in the "/Documents" folder.

    Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
    If (Not(IsComObjectCreated(hoReq))) Begin
        Send CreateComObject of hoReq
    End
    Set ComHttpVerb Of hoReq To "POST"
    // Note that our path uses GetFileByServerRelativeUrl and not GetFolderByServerRelativeUrl
    // Also, if your Sharepoint site is within a site collection, the URL is formatted like this (where "teamA" is the name of the site)
    // /sites/teamA/_api/web/GetFileByServerRelativeUrl('/sites/teamA/Documents/penguins2.jpg')/checkout

    // Note: To undo a checkout, replace "checkout" with "undocheckout" in the following line of code.
    Set ComPath Of hoReq To "/_api/web/GetFileByServerRelativeUrl('/Documents/penguins2.jpg')/checkout"

    // We need to add a form digest value in the X-RequestDigest header field.
    // See this example for details on
    // how to get (and cache) a form digest value
    Send ComAddHeader To hoReq "X-RequestDigest" "SHAREPOINT_FORM_DIGEST"

    // Send the POST using HTTPS (TLS). Port 443 is the default port for https.
    Move True To iBUseTls
    Get pvComObject of hoReq to vReq
    Get ComSynchronousRequest Of hoHttp "SHAREPOINT_HTTPS_DOMAIN" 443 iBUseTls vReq To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The response body contains XML.
    Get Create (RefClass(cComChilkatXml)) To hoXml
    If (Not(IsComObjectCreated(hoXml))) Begin
        Send CreateComObject of hoXml
    End
    Get ComBodyStr Of hoResp To sTemp1
    Get ComLoadXml Of hoXml sTemp1 To iSuccess

    Get ComStatusCode Of hoResp To iTemp1
    If (iTemp1 <> 200) Begin
        Get ComStatusCode Of hoResp To iTemp1
        Showln "Response status code = " iTemp1
        Get ComGetXml Of hoXml To sTemp1
        Showln sTemp1
        Showln "Failed"
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

    // Show the successful XML response.
    Get ComGetXml Of hoXml To sTemp1
    Showln sTemp1
    Showln "Success."

    // A successful XML response looks like this:
    // <?xml version="1.0" encoding="utf-8" ?>
    // <d:CheckOut xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" 
    // 	xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
    // 	xmlns:georss="http://www.georss.org/georss" 
    // 	xmlns:gml="http://www.opengis.net/gml" m:null="true" />
    // 
    // 


End_Procedure

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.