BINDINFO [Beta]
The BINDINFO structure is returned to the asynchronous moniker through IBindStatusCallback::GetBindInfo . The user of the asynchronous moniker uses this structure to qualify the binding operation that will be occurring. The meaning of this structure is somewhat specific to the type of the asynchronous moniker. The technical specification provided here describes the meaning of the structure when used for URL monikers.
typedef struct tagBINDINFO {
ULONG cbSize;
LPWSTR szExtraInfo;
STGMEDIUM stgmedData;
DWORD grfBindInfoF;
DWORD dwBindVerb,
LPWSTR szCustomVerb;
} BINDINFO;
Members
cbSize
Size of this structure, in bytes.
szExtraInfo
The behavior of this field is moniker specific. For URL monikers, this string is appended to the URL when the bind operation is started. Note: like all other OLE strings, this is a Unicode string that the client should allocate using CoMemAlloc. The URL Moniker will free the memory later.
stgmedData
Data to be PUT or POST.
grfBindInfoF
Flag from the BINDINFOF enumeration specifying additional flags modifying the bind operation. (URL specific).
dwBindVerb
A value from the BINDVERB enumeration specifying the action to be performed for the bind operation.
szCustomVerb
String specifying a protocol specific custom verb
to be used for the bind operation (only if grfBindInfoF
is set to BINDINFOF_CUSTOM)
See Also
IBindStatusCallback::GetBindInfo
CACHE_CONFIG_INFO [Beta]
Used by the cache management API functions, which provide controls to administrator to manage the files that are cached on the client storage. The management APIs are to be used only by a control panel applet to configure the cache.
typedef struct _CACHE_CONFIG_INFO {
DWORD dwFreshnessInterval;
// time to wait before file update
DWORD dwCleanupInterval;
// time interval between the unused file cleanups.
DWORD dwCleanupFactor;
// % of the cache storage freed up during cleanup.
DWORD dwTimetoCleanup;
// schedule cleanup, 0 - mid-night, 1 - 1:00 AM and so on.
BOOL PersistentCache;
// if set the cache is persistent across service restart.
DWORD dwNumCachePaths;
CACHE_PATH_ENTRY CachePaths[ANYSIZE_ARRAY];
} CACHE_CONFIG_INFO, *LPCACHE_CONFIG_INFO;
Members
dwFreshnessInterval
Time to wait before file update.
dwCleanupInterval
Time interval between the unused file cleanups
dwCleanupFactor
Percent of the cache storage freed up during cleanup.
dwTimetoCleanup
Schedule cleanup, 0 - mid-night, 1 - 1:00 AM and so on.A value from the BINDVERB enumeration specifying the action to be performed for the bind operation.
PersistentCache
If set the cache is persistent across service restart.
dwNumCachePaths
The number of cache paths.
See Also
GetUrlCacheConfigInfo , SetUrlCacheConfigInfo
CACHE_CONFIG_PATH_ENTRY [Beta]
Used by the cache management API functions, which provide controls to administrator to manage the files that are cached on the client storage. The management APIs are to be used only by a control panel applet to configure the cache.
typedef struct _CACHE_CONFIG_PATH_ENTRY {
TCHAR CachePath[MAX_PATH];
DWORD dwCacheSize; // IN KBytes
} CACHE_CONFIG_PATH_ENTRY, *LPCACHE_CONFIG_PATH_ENTRY;
Members
CachePath
The path of the cache.
dwCacheSize
Size of the cache in KBytes.
See Also
GetUrlCacheConfigInfo , SetUrlCacheConfigInfo
CACHE_ENTRY_INFO [Beta]
Used by the URL cache APIs to provide information about a URL that is cached. The structure is defined as follows:
typedef struct _CACHE_ENTRY_INFO {
DWORD dwVersion;
LPSTR lpszSourceUrlName;
LPTSTR% lpszLocalFileName;
DWORD CacheEntryType;
DWORD dwUseCount;
DWORD dwHitRate;
DWORD dwSizeLow;
DWORD dwSizeHigh;
FILETIME LastModifiedTime;
FILETIME ExpiryTime;
FILETIME LastAccessTime;
LPBYTE lpHeaderInfo;
DWORD dwHeaderInfoSize;
LPTSTR% lpszFileExtension;
DWORD dwReserved;
} CACHE_ENTRY_INFO, *LPCACHE_ENTRY_INFO;
Members
dwVersion
Version of the cache system
lpszSourceUrlName
Embedded pointer to the URL name string.
lpszLocalFileName
Embedded pointer to the local file name.
CacheEntryType
Cache type bit mask. Values are taken from the following flags.
Flag | Value | Definition |
NORMAL_CACHE_ENTRY | 0x00000001 | Normal cache entry, may be deleted to recover space for new entries. |
STABLE_CACHE_ENTRY | 0x00000002 | stable cache entry such as graphic and audio/vedio files, may be deleted to recover space for the new entries only when there is no more NORMAL_CACHE_ENTRY. |
STICKY_CACHE_ENTRY | 0x00000004 | These entries will never be removed automatically by the cache management system. |
SPARSE_CACHE_ENTRY | 0x00010000 | indicate this cache entry is incomplete. |
OCX_CACHE_ENTRY | 0x00020000 | Special OCX type cache entry. |
dwUseCount
Current user's count of the cache entry.
dwHitRate
The number of times the cache entry was retrieved.
dwSizeLow
Low DWORD of the file size.
dwSizeHigh
High DWORD of the file size.
LastModifiedTime
The time this file was last modified, in GMT format.
ExpiryTime
Expiry time of this file in GMT format.
LastAccessTime
The time this file was last accessed, in GMT format.
lpHeaderInfo
Embedded pointer to the header information
dwHeaderInfoSize
Size of the header pointed to in lpHeaderInfo.
lpszFileExtension
File extension used to retrieve the urldata as a file.
dwReserved
Reserved for future use.
See Also
HLBWINFO [Beta]
The HLBWINFO structure contains parameters relating to the locations and sizes of frame- and document-level windows within a browse context. The HLBWINFO structure is retrieved from the browse context using IHlinkBrowseContext::GetBrowseWindowInfo , and put into the browse context using IHlinkBrowseContext::SetBrowseWindowInfo . Hyperlink targets retrieve the HLBWINFO structure during IHlinkTarget::Navigate in order to reposition their user interface properly and ensure as seamless a transition as possible to the new document or object.
typedef struct tagHLBWINFO
{
ULONG cbSize;
DWORD grfHLBWIF;
RECTL rcFramePos;
RECTL rcDocPos;
} HLBWINFO;
Members
cbSize
Total size of this structure in bytes.
grfHLBWIF
Values taken from the HLBWIF enumeration.
rcFramePos
If grfHLBWIF & HLBWIF_HASFRAMEWNDINFO, contains the rectangle in screen coordinates of current frame-level windows within the browse context. When grfHLBWIF & HLBWIF_FRAMEWNDMAXIMIZED, frame-level windows are currently being displayed maximized. In this case rcFramePos is the "normal" size of frame-level windows, i.e. the rectangle to use for any frame-level window when it is non-maximized.
rcDocPos
If grfHLBWIF & HLBWIF_HASDOCWNDINFO, contains
the rectangle in screen coordinates of current document-level
windows within the browse context. When grfHLBWIF &
HLBWIF_DOCWNDMAXIMIZED, document-level windows are currently being
displayed maximized. In this case rcDocPos is the "normal"
size of document-level windows, i.e. the rectangle to use for
any document-level window when it is non-maximized.
See Also
HLBWIF , IHlinkBrowseContext::GetBrowseWindowInfo , IHlinkBrowseContext::SetBrowseWindowInfo , IHlinkTarget::Navigate
HLITEM [Beta]
The HLITEM structure is the data structure used by the system browse context to track hyperlinks. This structure is returned by the IEnumHLITEM enumerator, which is returned from IHlinkBrowseContext::EnumNavigationStack .
typedef struct tagHLITEM
{
ULONG uHLID;
LPWSTR szFriendlyName;
} HLITEM;
Members
uHLID
Identifies the hyperlink. Standard enumerators never return one of the logical HLID constants in this field, always an identifier.
szFriendlyName
Friendly name of the hyperlink. Appropriate for display
in the user interface.
See Also
HLID , IEnumHLITEM , IHlinkBrowseContext::EnumNavigationStack
OLECMD [Beta]
The OLECMD strcuture is used to associate command flags from the OLECMDF enumeration with a command identifer through IOleCommandTarget::QueryStatus .
typedef struct _tagOLECMD
{
ULONG cmdID;
DWORD cmdf;
}OLECMDF;
Members
cmdID
A command identifier; taken from the OLECMDID enumeration..
cmdf
Flags associated with cmdID; taken from the
OLECMDF
enumeration.
See Also
OLECMDF , IOleCommandTarget::QueryStatus
OLECMDTEXT [Beta]
Returns a text name or status string for a single command identifier. Used with IOleCommandTarget::QueryStatus .
typedef struct _tagOLECMDTEXT
{
DWORD cmdtextf;
ULONG cwactual;
ULONG cwbuf;
wchar_t rgwz[1];
}OLECMDTEXTF;
Members
cmdtextf
Filled on input; a value from the OLECMDTEXTF enumeration describing the information the caller wishes to receive in return.
cwActual
Filled on output; the number of characters actually written into the rgwz buffer before QueryStatus returns.
cwBuf
Filled on input; the size of the string buffer in cwBuf.
rgwz
A caller-allocated array of wide characters to receive
the string on output.
See Also
IOleCommandTarget::QueryStatus , OLECMDTEXTF
PAGERANGE [Beta]
Specifies a range of pages that begins and ends with page numbers that are selected by an end-user. The rgPageRange member of the PAGESET structure is a structure of type PAGERANGE.
typedef struct tagPAGERANGE
{
LONG nFromPage;
LONG nToPage;
}PAGERANGE;
Members
nFromPage
The first page to print. This member can have any page number as a value.If this value is greater than the value specified in nToPage, the document will be printed in reverse page order.
nToPage
The last page to print. A special value of PAGESET_TOLASTPAGE
indicates that all the remaining pages should be printed. This
member can have any page number as a value.If this value is less
than the value specified in nFromPage, the document will
be printed in reverse page order.
See Also
PAGESET [Beta]
Identifies one or more page-ranges to be printed and, optionally, identifies only the even or odd pages as part of a pageset.
typedef struct tagPAGESET
{
ULONG cbStruct;
BOOL fOddPages;
BOOL fEvenPages;
ULONG cPageRange;
[size_is(cPageRange)] PAGERANGE rgPages[]
}PAGESET;
Members
cbStruct
The number of bytes in this instance of the PAGESET structure. Must be a multiple of 4.
fOddPages
If true, then only the odd-numbered pages in the page-set indicated by rgPages are to be printed.
fEvenPages
If true, then only the even-numbered pages in the page-set indicated by rgPages are to be printed.
cPageRange
The number of page-range pairs specified in rgPages.
rgPages
Pointer to a PAGERANGE
structure specifying the pages to be printed. One or more
page ranges can be specified, so long as that number is the value
of cPageRange. The page ranges must be sorted in increasing
order and non-overlapping. It is an error to attempt to print
a page which does not exist.
See Also