IP*Works! WebDav Component : WebDav OCX, WebDav .NET Component, WebDav Class, WebDav Bean, WebDav Object

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The component allows remote management of resource properties and properties , including creation, deletion, listing, copying, and moving. Resource locking is also supported.

The ListDirectory and FindProperties methods will list the properties of a resource properties or resource, and a DirList or ResourceProperties event will be fired for each matching resource.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

A number of operations can be performed on resources by using the various methods of the component. Please refer to the individual methods for more information.

WebDAV allows non-standard properties to be specified through XML namespaces.

The namespaces are provided in the Namespaces properties , which is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


Accept	A list of acceptable MIME types for the request.
AuthScheme	The authentication scheme to use when server authorization is required.
Connected	Shows whether the component is connected.
CookieCount	The number of records in the Cookie arrays.
CookieDomain	The domain of a received cookie.
CookieExpiration	This property contains an expiration time for the cookie (if provided by the server).
CookieName	The name of the cookie.
CookiePath	This property contains a path name to limit the cookie to (if provided by the server).
CookieSecure	This property contains the security flag of the received cookie.
CookieValue	This property contains the value of the cookie.
Depth	The depth associated with the current operation.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the component.
LocalFile	The path to a local file used for DAV operations.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LockOwner	The principle that owns the current resource lock.
LockScope	The scope of the current resource lock.
LockTimeout	The time to live for the current resource lock.
LockTokens	The lock string to be used when submitting operations on a locked resource.
LockType	The type of the current resource lock.
NamespaceCount	The number of records in the Namespace arrays.
NamespacePrefix	The Prefix for the Namespace.
NamespaceURI	Namespace URI associated with the corresponding Prefix .
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaderCount	The number of records in the ParsedHeader arrays.
ParsedHeaderField	This property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValue	This property contains the header contents.
Password	A password if authentication is to be used.
PropertyCount	The number of records in the Property arrays.
PropertyAttr	This property shows the attribute string for the specified DAV property.
PropertyName	This property shows the name of the DAV property sent to or received from the server.
PropertyNamespaceURI	This property shows the DAV property namespace.
PropertyOperation	This property shows the operation to perform on a property when calling PatchProperties .
PropertyStatus	This property shows the status of the retrieved DAV property.
PropertyValue	This property shows the value of the DAV property.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
Referer	Referer URL/document (optional).
ResourceCount	The number of records in the Resource arrays.
ResourceContentLanguage	This property shows the language of the resource being returned.
ResourceContentLength	This property shows the length of the resource returned.
ResourceContentType	This property shows the type of the resource being returned.
ResourceDisplayName	This property shows the name of the resource being listed.
ResourceLastModified	This property shows the date/time stamp of the last time the resource was modified.
ResourceURI	This property shows the URI of the resource being returned.
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum of data to be transferred.
TransferredHeaders	The full set of headers as received from the server.
User	A user name if authentication is to be used.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


AddCookie	Adds a cookie and the corresponding value to the outgoing request headers.
AddNamespace	Adds a namespace to the Namespaces properties.
Config	Sets or retrieves a configuration setting.
CopyResource	Copy a resource to a new location.
DeleteResource	Delete a resource.
DoEvents	Processes events from the internal message queue.
FindProperties	Get resource property values from the server.
FindPropertyNames	Get resource property names from the server.
GetProperty	Get the value for a particular property.
GetResource	Get a resource using the WebDAV GET method.
Interrupt	Interrupt the current method.
ListDirectory	List the files and subdirectories of the ResourceURI.
LockResource	Obtain a lock for a specified resource.
MakeDirectory	Make a new directory.
MoveResource	Moves one resource to a new location.
PatchProperties	Update the current set of properties on the server.
PostToResource	Posts data to a resource using the WebDAV POST method.
PutResource	Send data to the server using the PUT method.
Reset	Reset the component.
SetProperty	Set the value of a property.
UnLockResource	Unlocks a resource.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
DirList	Fires for each entry returned in a directory listing.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
Redirect	Fired when a redirection is received from the server.
ResourceProperties	Fires for each entry returned through a property search.
SetCookie	Fired for every cookie set by the server.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


EncodeURL	If set to true the URL will be encoded by the component.
MaxResources	Instructs component to save the amount of resources specified that are returned by the server after a ListDirectory call has been made.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|