IVsPerPropertyBrowsing.HasDefaultValue Method

Article
04/22/2008

Determines if the current value for a property is the default.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Déclaration
Function HasDefaultValue ( _
    dispid As Integer, _
    <OutAttribute> ByRef fDefault As Integer _
) As Integer
'Utilisation
Dim instance As IVsPerPropertyBrowsing
Dim dispid As Integer
Dim fDefault As Integer
Dim returnValue As Integer

returnValue = instance.HasDefaultValue(dispid, _
    fDefault)

int HasDefaultValue(
    int dispid,
    out int fDefault
)

int HasDefaultValue(
    int dispid, 
    [OutAttribute] int% fDefault
)

function HasDefaultValue(
    dispid : int, 
    fDefault : int
) : int

Parameters

dispid
Type: System.Int32

[in] Specifies the dispatch ID.

fDefault
Type: System.Int32%

[out] Flag indicating the current property value is the default value.

Return Value

Type: System.Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsPerPropertyBrowsing::HasDefaultValue(
   DISPID dispid,
   [out, retval]BOOL* fDefault
);

Determines if the current value for a property is the default. If it is not the default, the property will be shown as bold in the Properties window to indicate that it has been modified from the default. Implementers should return a non-S_OK return code or *fDefault = true to display property value normally.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via