IWSDScopeMatchingRule::GetScopeRule method (wsddisco.h)

Is called to return a URI defining the implemented scope matching rule.

Syntax

HRESULT GetScopeRule(
  [out] LPCWSTR *ppszScopeMatchingRule
);

Parameters

[out] ppszScopeMatchingRule

Pointer to the scope matching rule. The implementer must allocate memory using WSDAllocateLinkedMemory and the caller must release memory using WSDFreeLinkedMemory.

Return value

Possible return values include, but are not limited to, the following:

Return code Description
S_OK
Method completed successfully.

Remarks

GetScopeRule should provide a copy of the URI for the scope matching rule this object represents. The copy will be released by the caller using WSDFreeLinkedMemory.

ppszScopeMatchingRule should never be NULL or an empty string. To register for the NULL scope matching rule, register for the RFC2396 rule as defined in WS-Discovery. Probe messages containing a NULL MatchBy value will be converted to RFC2396 before GetScopeRule is called.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wsddisco.h (include Wsdapi.h)
DLL Wsdapi.dll

See also

IWSDScopeMatchingRule