htmCategoryHTML - Solution Sites Routine

This function constructs an HTML representation of a particular set of products as specified by several parameters. The constructed HTML fragment is also cached for future use using the specified cache key.

Definition

Function htmCategoryHTML(
  oCatalog,
  sCatalogName,
  sCategoryName,
  oCategory,
  rsProducts,
  iPageNumber,
  nOutPagesTotal,
  sCacheKey)

Parameters

  • oCatalog
    A reference to a ProductCatalog object, passed through to the function htmRenderCategoryPage.
  • sCatalogName
    A string containing the name of the catalog, used as the page title when the category string is Null, and passed through to the function htmRenderCategoryPage.
  • sCategoryName
    A string containing the name of the category, used as the page title when not Null, and passed through to the function htmRenderCategoryPage.
  • oCategory
    A reference to a Category object, passed through to the function htmRenderCategoryPage.
  • rsProducts
    A reference to a Recordset object containing products to be represented in HTML, passed through to the function htmRenderCategoryPage.
  • iPageNumber
    An integer that specifies a particular page of products to be represented in HTML, passed through to the function htmRenderCategoryPage.
  • nOutPagesTotal
    An integer that specifies the total number of pages of products represented in the rsProducts parameter Recordset object, passed through to the function htmRenderCategoryPage.
  • sCacheKey
    A string containing a key under which the constructed HTML will be cached in the cache ProductListCache.

Return Value

A string containing the HTML representation of the products in the requested catalog, category, and page number.

Defined in File

category.asp.

Routines Called

CacheFragment

htmRenderCategoryPage

RenderText

Called By

Main (category.asp)

Remarks

This function uses the function htmRenderCategoryPage to perform the bulk of the work of creating the HTML representation of the requested product list. Many of the parameters are passed straight through to this function.

The constructed HTML string is cached for future use in the cache ProductListCache under the key specified by the sCacheKey parameter.

Copyright © 2005 Microsoft Corporation.
All rights reserved.