write method

Writes one or more HTML expressions to a document in the specified window.

Document Object Model (DOM) Level 2 HTML Specification, Section 1.5

Syntax

var retval = document.write(psarray);

Parameters

psarray [in]

Type: SAFEARRAY

A array of String that specifies the text and HTML tags to write.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Standards information

Document Object Model (DOM) Level 2 HTML Specification, Section 1.5

Remarks

Do not use the write method or the writeln method on the current document after the document has finished loading unless you first call the open method, which clears the current document window and erases all variables.

Note When document.write or document.writeln is used in an event handler, you must also use document.close.

Examples

This example shows how to write a string to the document.

C++


    IHTMLDocument2 *document; // Declared earlier in the code
    BSTR bstr = SysAllocString(OLESTR("Written by IHTMLDocument2::write()."));
    // Creates a new one-dimensional array
    SAFEARRAY *psaStrings = SafeArrayCreateVector(VT_VARIANT, 0, 1);
    if (psaStrings == NULL) {
        goto cleanup;
    }
    VARIANT *param;
    HRESULT hr = SafeArrayAccessData(psaStrings, (LPVOID*)&param);
    param->vt = VT_BSTR;
    param->bstrVal = bstr;
    hr = SafeArrayUnaccessData(psaStrings);
    hr = document->write(psaStrings);
cleanup:
    // SafeArrayDestroy calls SysFreeString for each BSTR
    if (psaStrings != NULL) {
        SafeArrayDestroy(psaStrings);
    }