Approve Method

  • Article

The Approve method approves the specified document as the current default version.

Function Approve( _varUrlsAs Variant, _
  [flagsAs Long] _)As _Recordset[C++]
HRESULT Approve(
VARIANTvarUrls,
    LONGflags, 
    _Recordset **ppResultsSet);

[Visual Basic]

Parameters
  • varUrls
    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 a bit mask that specifies the type of approval. See EnumKnowledge_ApproveFlags for possible values. The flags parameter also specifies the bit mask that indicates whether ServerXMLHTTP or WININET is used 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. The records that are returned contain fields in addition to the fields specific to the content class of the item. For more information about the properties returned, see SharePoint Portal Server Global Properties. 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

  • varUrls
    [in] 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
    [in] LONG that contains a bit mask that specifies the type of approval. See EnumKnowledge_ApproveFlags for possible values. The flags parameter also 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.

    The records that are returned contain fields in addition to the fields specific to the content class of the item. For more information about the properties returned, see SharePoint Portal Server Global Properties. 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

The Approve method succeeds only for documents that are published, and only if the user has the role of approver for this document.

Example

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