S/Web Objects - Repository

S/Web Objects

Links on this page:

Properties
Methods

Repository

This object handles information relating to the S/WEB repository.

This function is shelled by the DOCUMENT method, which should be used instead. This method is being documented for informational purposes only.

Properties:

Property	Get/Set	Description
CACHE	Get/Set	Defines whether all repository items are cached.
XVERSION	Get	Contains the current S/Web version

Methods:

call www_Exec_Method( "DOCUMENT", method, param1, param2, param3, param4, param5, errorText)

Method	Description
ACCESS	This function retrieves an item from the repository.
CREATE	Opens the handle of the WWW_DOCUMENT file and places it in the wwwDocumentHandle@ S/Web common variable.
GET	Gets properties of the repository object.
PURGE	Purges the current document cache.
SET	Sets properties of the current client object.

[top]

ACCESS method

This function retrieves an item from the repository.

Argument	Description
param1	The repository type (HTML, JS, CSS, etc.)
param2	The object name.
param3	Returned repository entity
param4	Returned repository record
param5	@VM delimited listField 1 Buffer numberField 2 Total buffer count
param6	Pass True$ to prevent this item from being cached

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical
......
loop
   www_Exec_Method( "REPOSITORY", "ACCESS", reposType, docID, reposEntity, reposRec, bufferInfo, ÄTrue$ )
   if www_Get_Status( errorText ) then
      abort = TRUE$
   end else
      call www_Exec_Method( "RESPONSE", "SETCONTENT", docBuffer, "+" )
      docBufferNo += 1
      if ( docBufferNo > docBufferCount ) then
         eofDocument = TRUE$
      end
   end
until ( bufferInfo<1> = bufferInfo<2> or abort )
repeat

[top]

GET method

This function retrieves the requested properties.

Argument	Description
param1	An @RM list of properties to retrieve
param2	An @RM list of retrieved property values.
param3	Not used.
param4	Not used.
param5	Not used.

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical
Properties = "CACHE"
if www_Exec_Method( "GET", "PROPERTY", Properties, RetVals, "", "", "", "", errorText ) then
CacheVal = Field( RetVals, @RM, 1 )
end else
abort = TRUE$
end

[top]

PURGE method

This function purges the repository cache table in memory on the server.

Argument	Description
param1	Not used
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

Example:

   declare function www_Exec_Method, www_Get_Status, www_Set_Status
   $insert www_Status_Equates
   $insert logical
   ......
   www_Exec_Method( "REPOSITORY", "PURGE", "", "", "", "", "", "" )

[top]

SET method

This function sets properties in the repository object.

Argument	Description
param1	An @RM list of properties to retrieve
param2	An @RM list of retrieved property values.
param3	An @RM list of original property values.
param4	Not used.
param5	Not used.

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical
* Stop caching documents.
Properties =   "CACHE"
Values      = False$
if www_Exec_Method( "SET", Properties, RetVals, OrigRetVals, "", "", "", errorText ) then
    OrigCacheVal        = Field( OrigRetVals, @RM, 1 )
end else
    abort = TRUE$
end

[top]