Soap.OPConvert.TSOAPConvertOption

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

TSOAPConvertOption = Soap.OpConvertOptions.TSOAPConvertOption;

Properties

Type Visibility Source Unit Parent
enum public Soap.OPConvert.pas Soap.OPConvert Soap.OPConvert

Description

TSOAPConvertOption and TSOAPConvertOptions represent flags that customize the conversion between a SOAP encoding and native method calls.

TSOAPConvertOptions is a set of TSOAPConvertOption values. TSOAPConvertOption values are flags that govern the conversions that TSOAPDomConv makes when translating between native code and its SOAP representation. The following table lists the possible values:



Option Meaning

soSendUntyped

When converting from a native type to SOAP, do not include the type attribute. Some Web Service applications do not need type information to be included in the SOAP request, but simply assume that values match the function signature.

soSendMultiRefObj

When converting from a native type to SOAP, indicate when multiple references refer to the same object. That is, treat objects considering that their identity is based on the object reference, rather than simply treating them as structures, where their identity is based only on the value of their properties.

soSendMultiRefArray

When converting from a native type to SOAP, indicate when multiple references refer to the same array. That is, treat arrays considering that their identity is based on the array reference, rather than simply treating them as structures, where their identity is based only on the value of their elements.

soTryAllSchema

When converting from SOAP to a native type, TSOAPDomConv assumes, by default, that xml schema definitions fall in the xml schema that is associated with the application. If it is possible that the SOAP request uses another xml schema to define standard types, include soTryAllSchema. This causes TSOAPDomConv to look in all schema documents that that are defined in the xml schema unit to locate type definitions.

soRootRefNodesToBody

When converting from a native type to SOAP, multiple references all appear as children of the <soap:body> tag, rather than as siblings of the first instance. This option is recommended, because some Web Service providers require multiple references to be rooted to the body tag and will not understand the request if this flag is not included.

soDocument

When converting from SOAP to a native type, assume that the request is encoded as a document rather than as a remote procedure call (RPC). This option is used when communicating with document servers.

soReturnSuccessForFault

When the server generates a SOAP fault packet, the response message should not have an error status code, but rather it should indicate success (200). This allows servers to send fault packets to clients that generate exceptions when an HTTP response does not indicate success.

soUTF8InHeader

When converting from native types to SOAP, include a SOAP header that indicates that the SOAP packet uses a UTF8 encoding style. Because the SOAP specification does not treat UTF8 as the default encoding style, this header is technically required. Some Web Service applications, however, do not use this header.

soDontSendEmptyNodes

When converting from native types to SOAP, do not include an element for empty strings , empty arrays, or nil (Delphi) or NULL (C++) object references.

soCacheMimeResponse

When converting a response from SOAP to native types, store the incoming response content in a temporary file rather than in memory if the binding type (TWebServiceBindingType) indicates that the response uses a MIME encoding. This is because MIME encodings indicate the presence of attachments, which can be very large. Only remove this flag if the expected attachments are known to be small.

soDontClearOutBoundHeaders

When converting from native types to SOAP, do not free any classes that represent headers after generating their SOAP representation.

soCustomFaultAtDetailsNode

When generating a SOAP fault packet to represent an exception, serialize information to the details node rather than as a child of the details node.

soLiteralParams

When converting from the SOAP encoding to native types, do not unwind parameter, even if the WSDL importer was called with the option for unwinding literal parameters. This option is needed in document literal encoding when the name of a method and the name of the structure representing its parameters are different.

soUTF8EncodeXML

When converting from native types to SOAP, encode characters at the transport level to UTF-8. This encoding is less efficient than DOM-level encoding, but is required for some Web Services that assume transport-level rather than DOM-level encoding.

soXXXXHdr

The type being converted represents a header.