Sample code for 30+ languages & platforms
Visual Basic 6.0 Requires Chilkat v11.7.0+

Box: Search Files with Offset Pagination

See more Box Examples

Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. Search within a folder hierarchy. Box search is indexed and may lag recent changes; use returned upload IDs for immediate follow-up requests. Search uses offset pagination, not folder-list markers.

See the Box API guide for setup and the complete workflow.

Chilkat Visual Basic 6.0 Downloads

Visual Basic 6.0
Dim success As Long
success = 0

'  Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
'  See Global Unlock Sample.
'  Guide: Box API Guide.

success = 0

'  BEGIN ONE-TIME SETUP
'  This block is repeated so each published example can run on its own.
'  In an application, run the setup example once and pass the SAME curl object
'  to operation code below. Do not recreate it for every operation.
'  See Reusable Box HttpCurl Setup.
Dim curl As New ChilkatHttpCurl
curl.SetVar "access_token","BOX_ACCESS_TOKEN"
curl.SetVar "parent_name","/"
'  Box's fixed root ID is an implementation detail; callers supply names.
curl.SetVar "parent_id","0"
Dim setupCommand As New ChilkatStringBuilder
Dim setupReplacements As Long

'  Register findParent; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findParent",setupCommand.GetAsString())
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

'  Register findFolder; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findFolder",setupCommand.GetAsString())
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

'  Register findFile; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findFile",setupCommand.GetAsString())
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

'  Register findDestination; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("findDestination",setupCommand.GetAsString())
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

'  Register getFileDetails; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("getFileDetails",setupCommand.GetAsString())
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

'  Register getEnterprise; registration sends no request.
success = setupCommand.SetString("curl -X GET ""https://api.box.com/2.0/users/me?fields=enterprise"" -H ""Authorization: Bearer ACCESS_TOKEN""")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.GetVar("access_token"))
success = curl.AddFunction("getEnterprise",setupCommand.GetAsString())
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

'  Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
'  when extracting each output, using the current value at that time.
success = curl.AddOutput2("findParent","entries","name","{{parent_name}}",1,"id","parent_id")
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

success = curl.AddOutput2("findFolder","entries","name","{{folder_name}}",1,"id","folder_id")
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

success = curl.AddOutput2("findFile","entries","name","{{file_name}}",1,"id","file_id")
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

success = curl.AddOutput2("findDestination","entries","name","{{destination_name}}",1,"id","destination_id")
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

success = curl.AddOutput("getFileDetails","file_version.id","file_version_id")
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

success = curl.AddOutput("getFileDetails","sha1","file_sha1")
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
If (success <> 1) Then
    Debug.Print curl.LastErrorText
    Exit Sub
End If

'  END ONE-TIME SETUP
'  The name lookups below assume each listing fits in one page (1000 items).
'  Parent and destination names select root children; folder_name selects a child
'  of parent_name. "/" selects the root parent. These are not arbitrary paths.

'  BEGIN OPERATION -- keep the configured object when reusing it.
'  Inputs are names. Retain cached IDs when the selected names have not changed.
Dim parentName As String
parentName = "/"
Dim folderName As String
folderName = "images"
If ((curl.GetVar("parent_name") <> parentName) Or ((parentName = "/") And (curl.VarDefined("parent_id") = 0))) Then
    curl.SetVar "parent_name",parentName
    curl.ClearVar "parent_id"
    curl.ClearVar "folder_id"
    curl.ClearVar "file_id"
    curl.ClearVar "file_version_id"
    curl.ClearVar "file_sha1"
    If (parentName = "/") Then
        curl.SetVar "parent_id","0"
    End If

End If

If (curl.GetVar("folder_name") <> folderName) Then
    curl.SetVar "folder_name",folderName
    curl.ClearVar "folder_id"
    curl.ClearVar "file_id"
    curl.ClearVar "file_version_id"
    curl.ClearVar "file_sha1"
End If

curl.SetVar "query","penguins"
Dim page As New ChilkatJsonObject
Dim number As New ChilkatStringBuilder
Dim offset As Long
offset = 0
Dim count As Long
Dim pageLimit As Long
Dim total As Long
Dim i As Long
Dim more As Long
more = 1
Do While more = 1
    number.Clear 
    success = number.AppendInt(offset)
    curl.SetVar "offset",number.GetAsString()
    curl.ClearTargetOutput "*"
    Dim authorizedCommand1 As New ChilkatStringBuilder
    success = authorizedCommand1.SetString("curl -X GET ""https://api.box.com/2.0/search?query={{query}}&type=file&ancestor_folder_ids={{folder_id}}&content_types=name&limit=100&offset={{offset}}"" -H ""Authorization: Bearer {{access_token}}""")
    Dim headerReplacement1 As Long
    headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.GetVar("access_token"))
    success = curl.DoYourThing(authorizedCommand1.GetAsString())
    If ((success <> 1) Or (curl.StatusCode <> 200)) Then
        Debug.Print "Box request failed. HTTP status: " & curl.StatusCode
        Debug.Print "Failure reason: " & curl.FailReason
        Debug.Print curl.ResponseBodyStr
        Exit Sub
    End If

    success = curl.GetResponseJson(page)
    If (success <> 1) Then
        Debug.Print curl.LastErrorText
        Exit Sub
    End If

    count = page.SizeOfArray("entries")
    i = 0
    Do While i < count
        page.I = i
        Debug.Print page.StringOf("entries[i].id") & " " & page.StringOf("entries[i].name")
        i = i + 1
    Loop
    pageLimit = page.IntOf("limit")
    total = page.IntOf("total_count")
    If (pageLimit <= 0) Then
        Debug.Print "Missing or invalid search page limit."
        Exit Sub
    End If

    offset = offset + pageLimit
    more = (offset < total) And (count > 0)
    If ((more = 1) And (offset > 9999)) Then
        Debug.Print "Search offset limit reached; narrow the query or folder scope."
        Exit Sub
    End If

Loop