Compartilhar via


Hold.SetHold método (Int32, SPListItemCollection, String)

NOTA: Esta API agora está obsoleta.

Aplica-se a suspensão especificada para todos os itens especificados.

Namespace:  Microsoft.Office.RecordsManagement.Holds
Assembly:  Microsoft.Office.Policy (em Microsoft.Office.Policy.dll)

Sintaxe

'Declaração
<ObsoleteAttribute("Use SetHold(items, hold, comments)")> _
Public Shared Function SetHold ( _
    holdID As Integer, _
    items As SPListItemCollection, _
    comments As String _
) As Boolean
'Uso
Dim holdID As Integer
Dim items As SPListItemCollection
Dim comments As String
Dim returnValue As Boolean

returnValue = Hold.SetHold(holdID, _
    items, comments)
[ObsoleteAttribute("Use SetHold(items, hold, comments)")]
public static bool SetHold(
    int holdID,
    SPListItemCollection items,
    string comments
)

Parâmetros

  • holdID
    Tipo: System.Int32

    O número inteiro que identifica o item de lista que representa a suspensão.

  • comments
    Tipo: System.String

    Qualquer comentário que você deseja gravar no log de auditoria quando a suspensão é aplicada a documentos especificados.

Valor retornado

Tipo: System.Boolean
Um valor booleano que indica se a suspensão foi aplicada com êxito para os itens especificados.

Ver também

Referência

Hold classe

Hold membros

SetHold em sobrecarga

Microsoft.Office.RecordsManagement.Holds namespace