_SiteConfigReadOnly::MakeArrayFromString

Use this method to convert an encoded string read from the Fields property into an Array. If the encoded string does not indicate Array properties, then the method returns the original string that was passed into it.

Definition

HRESULT _SiteConfig::MakeArrayFromString(VARIANTstrList,VARIANT*vtArray);

Parameters

strList

[in] A VARIANT that contains the encoded string.

vtArray

[out, retval] A pointer to a VARIANT used to return the converted Array or unconverted String.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

All ADO, SQL, and ODBC errors will also be returned by this method.

Remarks

The vtArray parameter points to valid data only if the method completes successfully.

Important

• There is a special group of methods used with multivalued arrays. These methods are the only approved and recommended way of storing and retrieving multivalued arrays in the Administration database. You must use the following methods with any property that has the structure of a multivalued array:

  • MakeArrayFromSimpleList

  • MakeSimpleListFromArray

  • MakeArrayFromString

  • MakeStringFromArray

Note

• This method can only be used on values exposed by the Fields object. The client-side disconnected ADO recordset has no support for Variants, Arrays, or objects as Fields columns. Therefore, the SiteConfigReadOnly object resorts to storing data in an encoded string format.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

See Also

SiteConfigReadOnly Object

All rights reserved.