Share via

Publish Method

  • Article

The Publish method submits the document for publication. If there is an approval workflow defined for this document, the workflow is initiated. If there is no approval workflow, the document is approved as the new default version.

Function Publish( _varUrlAs Variant, _
    [flagsAs Long] _)As _Recordset[C++]
HRESULT Publish(
VARIANTvarUrl,
    LONGflags, 
    _Recordset **ppResultsSet);

[Visual Basic]

Parameters
  • varUrl
    Variant that contains an array of Variants. Each Variant in the array contains a String that contains the URL of a document. Only one document can be specified.
  • flags
    Long that contains the bit mask that indicates whether to use ServerXMLHTTP or WININET to send the request. See EnumKnowledge_VersioningFlags for possible values.
Return Values

This method returns an ActiveX Data Objects (ADO) recordset that contains the new version. All recordsets returned by PKMCDO have RecordCount equal to -1. Instead of relying on the count, call MoveNext in a loop that checks for Recordset.EOF. For information about the format of the returned recordset, see Recordset Format.

Error Values

If an error is raised, Err.Number is set to one of the values documented on the Error Messages page.

[C++]

Parameters
  • varUrl
    [in] VARIANT that contains an array of VARIANTs. Each VARIANT in the array contains a BSTR that contains the URL of a document. Only one document can be specified.
  • flags
    LONG that contains the bit mask that indicates whether to use ServerXMLHTTP or WININET to send the request. See EnumKnowledge_VersioningFlags for possible values.
  • ppResultsSet
    [out, retval] Address of a pointer to an ActiveX Data Objects (ADO) recordset that contains the new version. All recordsets returned by PKMCDO have RecordCount equal to -1. Instead of relying on the count, call MoveNext in a loop that checks for Recordset.EOF. For information about the format of the returned recordset, see Recordset Format.
Return Values

For a list of error messages returned by SharePoint Portal Server, see Error Messages.

Remarks

If the document is currently checked out, it is checked in before it is published.

Example

To see an example of the version control process, see the example in IKnowledgeVersion interface.

To see this property in a fuller context, see Document Management Object Model Sample.